diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 1855e733ec..793ff13e3e 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -187,6 +187,10 @@ { "name": "campaigns", "description": "Endpoints to manage campaigns via the REST API." + }, + { + "name": "projects", + "description": "Endpoints to manage Projects using the REST API." } ], "servers": [ @@ -6334,6 +6338,653 @@ } } }, + "/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", @@ -14063,7 +14714,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -17856,7 +18507,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -22718,6 +23369,198 @@ } } }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "patch": { + "summary": "Update organization pattern configurations", + "description": "Updates the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, "/orgs/{org}/security-advisories": { "get": { "summary": "List repository security advisories for an organization", @@ -28946,6 +29789,312 @@ } } }, + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for a repository", + "description": "Gets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + }, + "examples": { + "default": { + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for a repository", + "description": "Sets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + }, + "examples": { + "default": { + "summary": "Set retention days", + "value": { + "days": 90 + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for a repository", + "description": "Gets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-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 a repository", + "description": "Sets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "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" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for a repository", + "description": "Gets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "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 a repository", + "description": "Sets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "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" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/repos/{owner}/{repo}/actions/permissions/selected-actions": { "get": { "summary": "Get allowed actions and reusable workflows for a repository", @@ -49148,6 +50297,320 @@ } } }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + "get": { + "summary": "List dependencies an issue is blocked by", + "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + }, + "post": { + "summary": "Add a dependency an issue is blocked by", + "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/add-blocked-by-dependency", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_id": { + "type": "integer", + "description": "The id of the issue that blocks the current issue" + } + }, + "required": [ + "issue_id" + ] + }, + "examples": { + "default": { + "value": { + "issue_id": 1 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { + "delete": { + "summary": "Remove dependency an issue is blocked by", + "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-dependency-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "name": "issue_id", + "in": "path", + "description": "The id of the blocking issue to remove as a dependency", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { + "get": { + "summary": "List dependencies an issue is blocking", + "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocking", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, "/repos/{owner}/{repo}/issues/{issue_number}/events": { "get": { "summary": "List issue events", @@ -101625,6 +103088,30 @@ "percent_completed" ] }, + "issue-dependencies-summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", @@ -101848,6 +103335,9 @@ }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" } }, "required": [ @@ -104183,6 +105673,124 @@ "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" + } + } + }, "nullable-simple-repository": { "title": "Simple Repository", "description": "A GitHub repository.", @@ -112397,6 +114005,104 @@ } ] }, + "secret-scanning-row-version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "secret-scanning-pattern-override": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + }, + "secret-scanning-pattern-configuration": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "$ref": "#/components/schemas/secret-scanning-pattern-override" + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "$ref": "#/components/schemas/secret-scanning-pattern-override" + } + } + } + }, "repository-advisory-vulnerability": { "description": "A product affected by the vulnerability detailed in a repository security advisory.", "type": "object", @@ -122998,6 +124704,9 @@ }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" } }, "required": [ @@ -128542,6 +130251,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "type": "string" }, @@ -134697,6 +136409,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -136074,6 +137789,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -138537,6 +140255,69 @@ "updated_at" ] }, + "nullable-projects-v2-status-update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, "projects-v2": { "title": "Projects v2 Project", "description": "A projects v2 project", @@ -138595,6 +140376,20 @@ }, "deleted_by": { "$ref": "#/components/schemas/nullable-simple-user" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "$ref": "#/components/schemas/nullable-projects-v2-status-update" + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -160191,6 +161986,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -161759,6 +163557,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -163336,6 +165137,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -165155,6 +166959,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -166585,6 +168392,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -167833,6 +169643,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -169074,6 +170887,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -170308,6 +172124,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -171568,6 +173387,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -172792,6 +174614,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -173997,6 +175822,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -175793,6 +177621,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -177080,6 +178911,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -178281,6 +180115,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -180277,6 +182114,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -275258,6 +277098,149 @@ } ] }, + "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", @@ -275578,136 +277561,6 @@ "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 - } - ] - } - }, "selected-actions": { "value": { "github_owned_allowed": true, @@ -280566,6 +282419,41 @@ } ] }, + "secret-scanning-pattern-configuration": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } + }, "list-repository-advisories": { "value": [ { @@ -302073,6 +303961,15 @@ "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.", @@ -302118,15 +304015,6 @@ "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.", diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 890b9cdf4d..ad8ecbc60e 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -99,6 +99,8 @@ tags: description: Revoke compromised or leaked GitHub credentials. - name: campaigns description: Endpoints to manage campaigns via the REST API. +- name: projects + description: Endpoints to manage Projects using the REST API. servers: - url: https://api.github.com externalDocs: @@ -4483,6 +4485,458 @@ 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 @@ -10283,7 +10737,7 @@ paths: Only organization owners can view assigned seats. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -13000,7 +13454,7 @@ paths: Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -16525,6 +16979,137 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/pattern-configurations": + get: + summary: List organization pattern configurations + description: |- + Lists the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + examples: + default: + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + patch: + summary: Update organization pattern configurations + description: |- + Updates the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization @@ -21092,6 +21677,215 @@ paths: previews: [] category: actions subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for a repository + description: |- + Gets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + examples: + default: + value: + days: 90 + maximum_allowed_days: 365 + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for a repository + description: |- + Sets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Empty response for successful settings update + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + examples: + default: + summary: Set retention days + value: + days: 90 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for a repository + description: |- + Gets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-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 a repository + description: |- + Sets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + 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 + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for a repository + description: |- + Gets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + 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 a repository + description: |- + Sets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + 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 + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/selected-actions": get: summary: Get allowed actions and reusable workflows for a repository @@ -35986,6 +36780,237 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": + get: + summary: List dependencies an issue is blocked by + description: |- + You can use the REST API to list the dependencies an issue is blocked by. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + post: + summary: Add a dependency an issue is blocked by + description: |- + You can use the REST API to add a 'blocked by' relationship to an issue. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': + "$ref": "#/components/responses/moved_permanently" + '403': + "$ref": "#/components/responses/forbidden" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": + delete: + summary: Remove dependency an issue is blocked by + description: |- + You can use the REST API to remove a dependency that an issue is blocked by. + + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + '301': + "$ref": "#/components/responses/moved_permanently" + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": + get: + summary: List dependencies an issue is blocking + description: |- + You can use the REST API to list the dependencies an issue is blocking. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events @@ -74018,6 +75043,23 @@ components: - total - completed - percent_completed + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and @@ -74188,6 +75230,8 @@ components: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" required: - assignee - closed_at @@ -75963,6 +77007,101 @@ 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 nullable-simple-repository: title: Simple Repository description: A GitHub repository. @@ -82564,6 +83703,89 @@ components: state: type: object description: The state of the ruleset version + secret-scanning-row-version: + type: string + description: The version of the entity. This is used to confirm you're updating + the current version of the entity and mitigate unintentionally overriding + someone else's update. + nullable: true + secret-scanning-pattern-override: + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: string + description: The version of this pattern if it's a custom pattern. + nullable: true + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this pattern. + alert_total_percentage: + type: integer + description: The percentage of all alerts that this pattern represents, + rounded to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated by this pattern. + false_positive_rate: + type: integer + description: The percentage of alerts from this pattern that are false positives, + rounded to the nearest integer. + bypass_rate: + type: integer + description: The percentage of blocks for this pattern that were bypassed, + rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: string + description: The push protection setting for this pattern set at the enterprise + level. Only present for partner patterns when the organization has a parent + enterprise. + enum: + - not-set + - disabled + - enabled + nullable: true + setting: + type: string + description: The current push protection setting for this pattern. If this + is `not-set`, then it inherits either the enterprise setting if it exists + or the default setting. + enum: + - not-set + - disabled + - enabled + secret-scanning-pattern-configuration: + title: Secret scanning pattern configuration + description: A collection of secret scanning patterns and their settings related + to push protection. + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: + "$ref": "#/components/schemas/secret-scanning-pattern-override" + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: + "$ref": "#/components/schemas/secret-scanning-pattern-override" repository-advisory-vulnerability: description: A product affected by the vulnerability detailed in a repository security advisory. @@ -90807,6 +92029,8 @@ components: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" required: - assignee - closed_at @@ -94852,6 +96076,8 @@ components: nullable: true sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: type: string state_reason: @@ -99594,6 +100820,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -100633,6 +101861,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -102537,6 +103767,55 @@ components: - name - created_at - updated_at + nullable-projects-v2-status-update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + start_date: + type: string + format: date + example: '2022-04-28' + target_date: + type: string + format: date + example: '2022-04-28' + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: + - id + - node_id + - created_at + - updated_at + nullable: true projects-v2: title: Projects v2 Project description: A projects v2 project @@ -102582,6 +103861,16 @@ components: nullable: true deleted_by: "$ref": "#/components/schemas/nullable-simple-user" + state: + type: string + enum: + - open + - closed + latest_status_update: + "$ref": "#/components/schemas/nullable-projects-v2-status-update" + is_template: + type: boolean + description: Whether this project is a template required: - id - node_id @@ -118581,6 +119870,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -119747,6 +121038,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -120920,6 +122213,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -122270,6 +123565,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -123330,6 +124627,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -124276,6 +125575,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -125205,6 +126506,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -126136,6 +127439,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -127090,6 +128395,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -128013,6 +129320,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -128918,6 +130227,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -130273,6 +131584,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -131247,6 +132560,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -132149,6 +133464,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -133656,6 +134973,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -206480,6 +207799,136 @@ 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 @@ -206744,127 +208193,6 @@ 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 selected-actions: value: github_owned_allowed: true @@ -210954,6 +212282,33 @@ components: parameters: operator: contains pattern: github + secret-scanning-pattern-configuration: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled list-repository-advisories: value: - ghsa_id: GHSA-abcd-1234-efgh @@ -229533,6 +230888,13 @@ 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 @@ -229576,13 +230938,6 @@ 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. diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 1855e733ec..793ff13e3e 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -187,6 +187,10 @@ { "name": "campaigns", "description": "Endpoints to manage campaigns via the REST API." + }, + { + "name": "projects", + "description": "Endpoints to manage Projects using the REST API." } ], "servers": [ @@ -6334,6 +6338,653 @@ } } }, + "/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", @@ -14063,7 +14714,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -17856,7 +18507,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -22718,6 +23369,198 @@ } } }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "patch": { + "summary": "Update organization pattern configurations", + "description": "Updates the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, "/orgs/{org}/security-advisories": { "get": { "summary": "List repository security advisories for an organization", @@ -28946,6 +29789,312 @@ } } }, + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for a repository", + "description": "Gets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + }, + "examples": { + "default": { + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for a repository", + "description": "Sets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + }, + "examples": { + "default": { + "summary": "Set retention days", + "value": { + "days": 90 + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for a repository", + "description": "Gets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-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 a repository", + "description": "Sets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "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" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for a repository", + "description": "Gets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "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 a repository", + "description": "Sets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "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" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/repos/{owner}/{repo}/actions/permissions/selected-actions": { "get": { "summary": "Get allowed actions and reusable workflows for a repository", @@ -49148,6 +50297,320 @@ } } }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + "get": { + "summary": "List dependencies an issue is blocked by", + "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + }, + "post": { + "summary": "Add a dependency an issue is blocked by", + "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/add-blocked-by-dependency", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_id": { + "type": "integer", + "description": "The id of the issue that blocks the current issue" + } + }, + "required": [ + "issue_id" + ] + }, + "examples": { + "default": { + "value": { + "issue_id": 1 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { + "delete": { + "summary": "Remove dependency an issue is blocked by", + "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-dependency-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "name": "issue_id", + "in": "path", + "description": "The id of the blocking issue to remove as a dependency", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { + "get": { + "summary": "List dependencies an issue is blocking", + "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocking", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, "/repos/{owner}/{repo}/issues/{issue_number}/events": { "get": { "summary": "List issue events", @@ -101625,6 +103088,30 @@ "percent_completed" ] }, + "issue-dependencies-summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", @@ -101848,6 +103335,9 @@ }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" } }, "required": [ @@ -104183,6 +105673,124 @@ "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" + } + } + }, "nullable-simple-repository": { "title": "Simple Repository", "description": "A GitHub repository.", @@ -112397,6 +114005,104 @@ } ] }, + "secret-scanning-row-version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "secret-scanning-pattern-override": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + }, + "secret-scanning-pattern-configuration": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "$ref": "#/components/schemas/secret-scanning-pattern-override" + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "$ref": "#/components/schemas/secret-scanning-pattern-override" + } + } + } + }, "repository-advisory-vulnerability": { "description": "A product affected by the vulnerability detailed in a repository security advisory.", "type": "object", @@ -122998,6 +124704,9 @@ }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" } }, "required": [ @@ -128542,6 +130251,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "type": "string" }, @@ -134697,6 +136409,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -136074,6 +137789,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -138537,6 +140255,69 @@ "updated_at" ] }, + "nullable-projects-v2-status-update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, "projects-v2": { "title": "Projects v2 Project", "description": "A projects v2 project", @@ -138595,6 +140376,20 @@ }, "deleted_by": { "$ref": "#/components/schemas/nullable-simple-user" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "$ref": "#/components/schemas/nullable-projects-v2-status-update" + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -160191,6 +161986,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -161759,6 +163557,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -163336,6 +165137,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -165155,6 +166959,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -166585,6 +168392,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -167833,6 +169643,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -169074,6 +170887,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -170308,6 +172124,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -171568,6 +173387,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -172792,6 +174614,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -173997,6 +175822,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -175793,6 +177621,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -177080,6 +178911,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -178281,6 +180115,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -180277,6 +182114,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -275258,6 +277098,149 @@ } ] }, + "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", @@ -275578,136 +277561,6 @@ "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 - } - ] - } - }, "selected-actions": { "value": { "github_owned_allowed": true, @@ -280566,6 +282419,41 @@ } ] }, + "secret-scanning-pattern-configuration": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } + }, "list-repository-advisories": { "value": [ { @@ -302073,6 +303961,15 @@ "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.", @@ -302118,15 +304015,6 @@ "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.", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 890b9cdf4d..ad8ecbc60e 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -99,6 +99,8 @@ tags: description: Revoke compromised or leaked GitHub credentials. - name: campaigns description: Endpoints to manage campaigns via the REST API. +- name: projects + description: Endpoints to manage Projects using the REST API. servers: - url: https://api.github.com externalDocs: @@ -4483,6 +4485,458 @@ 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 @@ -10283,7 +10737,7 @@ paths: Only organization owners can view assigned seats. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -13000,7 +13454,7 @@ paths: Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -16525,6 +16979,137 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/pattern-configurations": + get: + summary: List organization pattern configurations + description: |- + Lists the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + examples: + default: + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + patch: + summary: Update organization pattern configurations + description: |- + Updates the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization @@ -21092,6 +21677,215 @@ paths: previews: [] category: actions subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for a repository + description: |- + Gets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + examples: + default: + value: + days: 90 + maximum_allowed_days: 365 + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for a repository + description: |- + Sets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Empty response for successful settings update + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + examples: + default: + summary: Set retention days + value: + days: 90 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for a repository + description: |- + Gets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-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 a repository + description: |- + Sets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + 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 + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for a repository + description: |- + Gets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + 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 a repository + description: |- + Sets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + 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 + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/selected-actions": get: summary: Get allowed actions and reusable workflows for a repository @@ -35986,6 +36780,237 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": + get: + summary: List dependencies an issue is blocked by + description: |- + You can use the REST API to list the dependencies an issue is blocked by. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + post: + summary: Add a dependency an issue is blocked by + description: |- + You can use the REST API to add a 'blocked by' relationship to an issue. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': + "$ref": "#/components/responses/moved_permanently" + '403': + "$ref": "#/components/responses/forbidden" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": + delete: + summary: Remove dependency an issue is blocked by + description: |- + You can use the REST API to remove a dependency that an issue is blocked by. + + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + '301': + "$ref": "#/components/responses/moved_permanently" + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": + get: + summary: List dependencies an issue is blocking + description: |- + You can use the REST API to list the dependencies an issue is blocking. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events @@ -74018,6 +75043,23 @@ components: - total - completed - percent_completed + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and @@ -74188,6 +75230,8 @@ components: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" required: - assignee - closed_at @@ -75963,6 +77007,101 @@ 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 nullable-simple-repository: title: Simple Repository description: A GitHub repository. @@ -82564,6 +83703,89 @@ components: state: type: object description: The state of the ruleset version + secret-scanning-row-version: + type: string + description: The version of the entity. This is used to confirm you're updating + the current version of the entity and mitigate unintentionally overriding + someone else's update. + nullable: true + secret-scanning-pattern-override: + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: string + description: The version of this pattern if it's a custom pattern. + nullable: true + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this pattern. + alert_total_percentage: + type: integer + description: The percentage of all alerts that this pattern represents, + rounded to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated by this pattern. + false_positive_rate: + type: integer + description: The percentage of alerts from this pattern that are false positives, + rounded to the nearest integer. + bypass_rate: + type: integer + description: The percentage of blocks for this pattern that were bypassed, + rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: string + description: The push protection setting for this pattern set at the enterprise + level. Only present for partner patterns when the organization has a parent + enterprise. + enum: + - not-set + - disabled + - enabled + nullable: true + setting: + type: string + description: The current push protection setting for this pattern. If this + is `not-set`, then it inherits either the enterprise setting if it exists + or the default setting. + enum: + - not-set + - disabled + - enabled + secret-scanning-pattern-configuration: + title: Secret scanning pattern configuration + description: A collection of secret scanning patterns and their settings related + to push protection. + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: + "$ref": "#/components/schemas/secret-scanning-pattern-override" + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: + "$ref": "#/components/schemas/secret-scanning-pattern-override" repository-advisory-vulnerability: description: A product affected by the vulnerability detailed in a repository security advisory. @@ -90807,6 +92029,8 @@ components: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" required: - assignee - closed_at @@ -94852,6 +96076,8 @@ components: nullable: true sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: type: string state_reason: @@ -99594,6 +100820,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -100633,6 +101861,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -102537,6 +103767,55 @@ components: - name - created_at - updated_at + nullable-projects-v2-status-update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + start_date: + type: string + format: date + example: '2022-04-28' + target_date: + type: string + format: date + example: '2022-04-28' + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: + - id + - node_id + - created_at + - updated_at + nullable: true projects-v2: title: Projects v2 Project description: A projects v2 project @@ -102582,6 +103861,16 @@ components: nullable: true deleted_by: "$ref": "#/components/schemas/nullable-simple-user" + state: + type: string + enum: + - open + - closed + latest_status_update: + "$ref": "#/components/schemas/nullable-projects-v2-status-update" + is_template: + type: boolean + description: Whether this project is a template required: - id - node_id @@ -118581,6 +119870,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -119747,6 +121038,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -120920,6 +122213,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -122270,6 +123565,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -123330,6 +124627,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -124276,6 +125575,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -125205,6 +126506,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -126136,6 +127439,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -127090,6 +128395,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -128013,6 +129320,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -128918,6 +130227,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -130273,6 +131584,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -131247,6 +132560,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -132149,6 +133464,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -133656,6 +134973,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -206480,6 +207799,136 @@ 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 @@ -206744,127 +208193,6 @@ 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 selected-actions: value: github_owned_allowed: true @@ -210954,6 +212282,33 @@ components: parameters: operator: contains pattern: github + secret-scanning-pattern-configuration: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled list-repository-advisories: value: - ghsa_id: GHSA-abcd-1234-efgh @@ -229533,6 +230888,13 @@ 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 @@ -229576,13 +230938,6 @@ 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. diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 60df0fe511..d82485b918 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -187,6 +187,10 @@ { "name": "campaigns", "description": "Endpoints to manage campaigns via the REST API." + }, + { + "name": "projects", + "description": "Endpoints to manage Projects using the REST API." } ], "servers": [ @@ -26054,6 +26058,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -41194,6 +41222,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -46970,6 +47022,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -50599,17 +50675,17 @@ } } }, - "/organizations/{org}/dependabot/repository-access": { + "/organizations/{org}/actions/permissions/artifact-and-log-retention": { "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.", + "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": [ - "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/permissions#get-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -50620,29 +50696,6 @@ "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": { @@ -50651,523 +50704,28 @@ "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": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal", - "nullable": true + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" }, - "accessible_repositories": { - "type": "array", - "items": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "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" - ], - "nullable": true - } + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" } }, - "additionalProperties": false + "required": [ + "days", + "maximum_allowed_days" + ] }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "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" - } - ] + "days": 90, + "maximum_allowed_days": 365 } } } @@ -51228,22 +50786,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } }, - "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```", + "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": [ - "dependabot" + "actions" ], - "operationId": "dependabot/update-repository-access-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/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -51263,50 +50820,19 @@ "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." + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" } }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } + "required": [ + "days" + ] }, "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", + "application/json": { "value": { - "repository_ids_to_remove": [ - 789 - ] + "days": 100 } } } @@ -51315,7 +50841,7 @@ }, "responses": { "204": { - "description": "Response" + "description": "No content" }, "403": { "description": "Forbidden", @@ -51368,77 +50894,9 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" - } - } - }, - "/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": [ - "dependabot" - ], - "operationId": "dependabot/set-repository-access-default-level", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" - }, - "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": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal" - } - }, - "required": [ - "default_level" - ] - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", - "value": { - "default_level": "public" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -51463,14 +50921,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -51478,11 +50940,50 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -51491,24 +50992,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } } }, - "/organizations/{org}/settings/billing/usage": { + "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { "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).\"", + "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": [ - "billing" + "actions" ], - "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" + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -51519,144 +51019,42 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { "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" - ] - } + "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": { - "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" - } - ] + "approval_policy": "first_time_contributors" } } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -51678,45 +51076,44 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } + } + }, + "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" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -51741,14 +51138,18 @@ } } }, - "500": { - "description": "Internal Error", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -51756,33 +51157,83 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "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" } } } @@ -51790,24 +51241,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "billing", - "subcategory": "enhanced-billing" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}": { + "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { "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 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": [ - "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-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -51826,438 +51276,65 @@ "content": { "application/json": { "schema": { - "title": "Organization Full", - "description": "Organization Full", "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": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true, - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "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", - "nullable": true - }, - "default_repository_branch": { - "type": "string", - "example": "main", - "nullable": true, - "description": "The default branch for repositories created in this organization." - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_delete_repositories": { - "type": "boolean", - "example": true - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "example": true - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "example": true - }, - "members_can_delete_issues": { - "type": "boolean", - "example": true - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "example": true - }, - "readers_can_create_discussions": { - "type": "boolean", - "example": true - }, - "members_can_create_teams": { - "type": "boolean", - "example": true - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { + "run_workflows_from_fork_pull_requests": { "type": "boolean", - "example": false, - "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.", - "deprecated": true + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "secret_scanning_push_protection_enabled_for_new_repositories": { + "send_write_tokens_to_workflows": { "type": "boolean", - "example": false, - "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.", - "deprecated": true + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "secret_scanning_push_protection_custom_link_enabled": { + "send_secrets_and_variables": { "type": "boolean", - "example": false, - "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", - "example": "https://github.com/test-org/test-repo/blob/main/README.md", - "nullable": true, - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "deploy_keys_enabled_for_repositories": { + "require_approval_for_fork_pr_workflows": { "type": "boolean", - "example": false, - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } - }, - "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": { + "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 + "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": { + "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" } } } @@ -52292,22 +51369,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "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 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": [ - "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-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -52321,171 +51397,40 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], "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": { - "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", - "example": "\"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": { + "run_workflows_from_fork_pull_requests": { "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 + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "secret_scanning_push_protection_enabled_for_new_repositories": { + "send_write_tokens_to_workflows": { "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 + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "secret_scanning_push_protection_custom_link_enabled": { + "send_secrets_and_variables": { "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." + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "deploy_keys_enabled_for_repositories": { + "require_approval_for_fork_pr_workflows": { "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } } }, "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" + "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 } } } @@ -52493,553 +51438,73 @@ } }, "responses": { - "200": { - "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": "Organization Full", - "description": "Organization Full", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true, - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "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", - "nullable": true - }, - "default_repository_branch": { - "type": "string", - "example": "main", - "nullable": true, - "description": "The default branch for repositories created in this organization." - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_delete_repositories": { - "type": "boolean", - "example": true - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "example": true - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "example": true - }, - "members_can_delete_issues": { - "type": "boolean", - "example": true - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "example": true - }, - "readers_can_create_discussions": { - "type": "boolean", - "example": true - }, - "members_can_create_teams": { - "type": "boolean", - "example": true - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "example": false, - "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", - "example": "https://github.com/test-org/test-repo/blob/main/README.md", - "nullable": true, - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true + "type": "string" }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "example": false, - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." - } - }, - "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 + "status": { + "type": "string" } } } } } }, - "422": { - "description": "Validation failed", + "404": { + "description": "Resource not found", "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -53047,11 +51512,50 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -53060,22 +51564,23 @@ } }, "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", + } + }, + "/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": [ - "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#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -53089,23 +51594,45 @@ } ], "responses": { - "202": { - "description": "Accepted", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "type": "object" + "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": { - "default": { - "value": null + "response": { + "summary": "Example response", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } } } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -53130,8 +51657,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -53158,24 +51685,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } - } - }, - "/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.", + }, + "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" ], - "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#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -53188,67 +51712,207 @@ } } ], + "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": { - "200": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_active_caches_count": { - "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." + "message": { + "type": "string" }, - "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." + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - }, - "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 + } + } + } + } + }, + "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" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "409": { + "description": "Conflict", + "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" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/cache/usage-by-repository": { + "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { "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.", + "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" ], - "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#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -53286,304 +51950,739 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repository_cache_usages" - ], "properties": { "total_count": { "type": "integer" }, - "repository_cache_usages": { + "repositories": { "type": "array", "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { "type": "string", - "example": "octo-org/Hello-World" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer", - "example": 2322142 + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "example": 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": "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/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/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": { - "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", + "full_name": { "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 + "example": "octocat/Hello-World" }, - "image_details": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "key": { "type": "string", - "example": "ubuntu-20.04" + "example": "mit" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "name": { + "type": "string", + "example": "MIT License" }, - "display_name": { - "description": "Display name for this image.", + "url": { "type": "string", - "example": 20.04 + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "source": { - "description": "The image provider.", + "spdx_id": { "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "id", - "size_gb", - "display_name", - "source" + "key", + "name", + "url", + "spdx_id", + "node_id" ], "nullable": true }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "example": "8-core" + "example": "octocat" }, - "cpu_cores": { - "description": "The number of cores.", + "id": { "type": "integer", - "example": 8 + "format": "int64", + "example": 1 }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "cpu_cores", - "memory_gb", - "storage_gb" + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "status": { - "description": "The status of the runner.", + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "platform": { - "description": "The operating system of the image.", + "description": { "type": "string", - "example": "linux-x64" + "example": "This your first repo!", + "nullable": true }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { "type": "integer", - "default": 10, - "example": 5 + "example": 9 }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, "type": "boolean", "example": true }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "topics": { "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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } + "type": "string" } }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": "string", "format": "date-time", - "example": "2022-10-09T23:39:01Z", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" + "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" ] } } @@ -53592,89 +52691,207 @@ "examples": { "default": { "value": { - "total_count": 2, - "runners": [ + "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 + "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 }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } + "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" ], - "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 + "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 }, - "machine_size_details": { - "id": "8-core", - "cpu_cores": 8, - "memory_gb": 32, - "storage_gb": 300 + "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" }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" + "forks": 1, + "open_issues": 1, + "watchers": 1 } ] } } } } - }, - "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 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/hosted-runners#create-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -53693,66 +52910,27 @@ "application/json": { "schema": { "type": "object", + "required": [ + "selected_repository_ids" + ], "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" + "selected_repository_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" } - }, - "required": [ - "name", - "image", - "size", - "runner_group_id" - ] + } }, "examples": { - "default": { + "application/json": { "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 + "selected_repository_ids": [ + 1, + 2, + 3 + ] } } } @@ -53760,336 +52938,149 @@ } }, "responses": { - "201": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 + "message": { + "type": "string" }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true + "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "url": { + "type": "string" }, "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": true + "documentation_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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } + "url": { + "type": "string" }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" + "status": { + "type": "string" } } } } } - } - }, - "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", + }, + "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", - "images" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "images": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", "type": "object", + "required": [ + "code" + ], "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" + "resource": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" + "field": { + "type": "string" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "message": { + "type": "string" }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 + "code": { + "type": "string" }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } ] } - }, - "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" + "subcategory": "permissions" } } }, - "/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", + "/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/hosted-runners#get-partner-images-for-github-hosted-runners-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": [ { @@ -54100,105 +53091,185 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", + "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" + } + } + } + } + } + }, + "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": [ - "total_count", - "images" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "images": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", "type": "object", + "required": [ + "code" + ], "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" + "resource": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" + "field": { + "type": "string" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "message": { + "type": "string" }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 + "code": { + "type": "string" }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } ] } - }, - "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" + "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", + }, + "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/hosted-runners#get-limits-on-github-hosted-runners-for-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": [ { @@ -54209,242 +53280,187 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "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.", - "example": 50 - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "example": 17 - } - }, - "required": [ - "maximum", - "current_usage" - ] - } - }, - "required": [ - "public_ips" - ] - }, - "examples": { - "default": { - "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "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", + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "machine_specs" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 + } + } + } + }, + "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": "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", + }, + "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", - "platforms" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "platforms": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "/organizations/{org}/dependabot/repository-access": { "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": "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": "actions/get-hosted-runner-for-org", + "operationId": "dependabot/repository-access-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/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -54457,12 +53473,26 @@ } }, { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, "schema": { - "type": "integer" + "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 } } ], @@ -54472,1250 +53502,47 @@ "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", + "default_level": { "type": "string", - "example": "my-github-hosted-runner" + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal", + "nullable": true }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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": "hosted-runners" - } - }, - "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/hosted-runners#update-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" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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" - } - } - }, - "examples": { - "default": { - "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "hosted-runners" - } - }, - "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": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#delete-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" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "202": { - "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" - } - } - } - } - } - } - }, - "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", - "content": { - "application/json": { - "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", - "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" - } - } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "oidc" - } - }, - "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.", - "tags": [ - "oidc" - ], - "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" - }, - "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": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", - "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" - } - } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Empty response", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "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": { - "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", - "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" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." - }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] - }, - "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" - } - } - } - } - } - } - }, - "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": { - "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", - "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" - }, - "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/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": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "number" - }, - "repositories": { + "accessible_repositories": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "example": 42, "type": "integer", - "format": "int64" + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." }, "name": { - "description": "The name of the repository.", "type": "string", - "example": "Team Environment" + "example": "Hello-World", + "description": "The name of the repository." }, "full_name": { "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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" - ] + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", @@ -55842,438 +53669,223 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true + "nullable": true, + "description": "The repository description." }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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" - } - } + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." } }, "required": [ @@ -56322,57 +53934,34 @@ "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" - ] + "url" + ], + "nullable": true } } - } + }, + "additionalProperties": false }, "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "default_level": "public", + "accessible_repositories": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", + "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://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", + "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", + "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}", @@ -56383,105 +53972,51 @@ "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 + "site_admin": false, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" }, "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", "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 + "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" } ] } @@ -56489,25 +54024,77 @@ } } } + }, + "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" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" } }, - "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", + "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-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -56520,11 +54107,6 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { "required": true, "content": { @@ -56532,25 +54114,49 @@ "schema": { "type": "object", "properties": { - "selected_repository_ids": { - "description": "List of repository IDs to enable for GitHub Actions.", + "repository_ids_to_add": { "type": "array", "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } + "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": [ - "selected_repository_ids" - ] + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } }, "examples": { - "default": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", "value": { - "selected_repository_ids": [ - 32, - 42 + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 ] } } @@ -56558,25 +54164,82 @@ } } }, + "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "/organizations/{org}/dependabot/repository-access/default-level": { "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": "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#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -56587,273 +54250,90 @@ "schema": { "type": "string" } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "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" + ], + "example": "internal" + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, "responses": { "204": { "description": "Response" - } - }, - "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", - "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" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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", + "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" - } - } - } - }, - "examples": { - "default": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - } - } - } - } - } - } - }, - "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": { + "url": { + "type": "string" + }, + "status": { "type": "string" } } } - }, - "examples": { - "selected_actions": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - } - } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/orgs/{org}/actions/permissions/workflow": { - "get": { - "summary": "Get default workflow permissions for an organization", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-github-actions-default-workflow-permissions-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-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", + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] + "message": { + "type": "string" }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - }, - "required": [ - "default_workflow_permissions", - "can_approve_pull_request_reviews" - ] - }, - "examples": { - "default": { - "summary": "Give read-only permission, and allow approving PRs.", - "value": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -56864,89 +54344,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set default workflow permissions for an organization", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/set-github-actions-default-workflow-permissions-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-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": "Success response" - } - }, - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] - }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - } - }, - "examples": { - "default": { - "summary": "Give read-only permission, and allow approving PRs.", - "value": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/orgs/{org}/actions/runner-groups": { + "/organizations/{org}/settings/billing/usage": { "get": { - "summary": "List self-hosted runner groups for an organization", - "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-self-hosted-runner-groups-for-org", + "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/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" }, "parameters": [ { @@ -56959,116 +54372,111 @@ } }, { - "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).\"", + "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", - "default": 30 + "type": "integer" } }, { - "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).\"", + "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", - "default": 1 + "type": "integer" } }, { - "name": "visible_to_repository", - "description": "Only return runner groups that are allowed to be used by this repository.", + "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": "string" + "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": [ - "total_count", - "runner_groups" - ], "properties": { - "total_count": { - "type": "number" - }, - "runner_groups": { + "usageItems": { "type": "array", "items": { "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" + "date": { + "type": "string", + "description": "Date of the usage line item." }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "product": { + "type": "string", + "description": "Product name." }, - "runners_url": { - "type": "string" + "sku": { + "type": "string", + "description": "SKU name." }, - "hosted_runners_url": { - "type": "string" + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." }, - "inherited": { - "type": "boolean" + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." }, - "inherited_allows_public_repositories": { - "type": "boolean" + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." }, - "allows_public_repositories": { - "type": "boolean" + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false + "organizationName": { + "type": "string", + "description": "Name of the organization." }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "repositoryName": { + "type": "string", + "description": "Name of the repository." } }, "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" ] } } @@ -57077,48 +54485,19 @@ "examples": { "default": { "value": { - "total_count": 3, - "runner_groups": [ - { - "id": 1, - "name": "Default", - "visibility": "all", - "default": true, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [], - "workflow_restrictions_read_only": false - }, - { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "inherited": true, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": true - }, + "usageItems": [ { - "id": 3, - "name": "expensive-hardware", - "visibility": "private", - "default": false, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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" } ] } @@ -57126,212 +54505,134 @@ } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - }, - "post": { - "summary": "Create a self-hosted runner group for an organization", - "description": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/create-self-hosted-runner-group-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-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 group.", - "type": "string" - }, - "visibility": { - "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "type": "string", - "enum": [ - "selected", - "all", - "private" - ], - "default": "all" - }, - "selected_repository_ids": { - "description": "List of repository IDs that can access the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } - }, - "runners": { - "description": "List of runner IDs to add to the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - } - }, - "allows_public_repositories": { - "description": "Whether the runner group can be used by `public` repositories.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + }, + "400": { + "description": "Bad Request", + "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" } - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" } - }, - "required": [ - "name" - ] + } }, - "examples": { - "default": { - "value": { - "name": "Expensive hardware runners", - "visibility": "selected", - "selected_repository_ids": [ - 32, - 91 - ], - "runners": [ - 9, - 2 - ] + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } } } } } - } - }, - "responses": { - "201": { - "description": "Response", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { + "message": { "type": "string" }, - "visibility": { + "documentation_url": { "type": "string" }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "url": { "type": "string" }, - "runners_url": { + "status": { "type": "string" - }, - "hosted_runners_url": { + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { "type": "string" }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", + "documentation_url": { "type": "string" }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" + "url": { + "type": "string" }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false + "message": { + "type": "string" }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - }, - "examples": { - "default": { - "value": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "documentation_url": { + "type": "string" } } } @@ -57340,24 +54641,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "/orgs/{org}": { "get": { - "summary": "Get a self-hosted runner group for an organization", - "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-self-hosted-runner-group-for-org", + "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/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -57368,15 +54669,6 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -57385,91 +54677,464 @@ "content": { "application/json": { "schema": { + "title": "Organization Full", + "description": "Organization Full", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, "id": { - "type": "number" + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, "name": { - "type": "string" + "type": "string", + "example": "github" }, - "visibility": { - "type": "string" + "company": { + "type": "string", + "example": "GitHub" }, - "default": { - "type": "boolean" + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "location": { + "type": "string", + "example": "San Francisco" }, - "runners_url": { - "type": "string" + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" }, - "hosted_runners_url": { - "type": "string" + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "is_verified": { + "type": "boolean", + "example": true }, - "inherited": { - "type": "boolean" + "has_organization_projects": { + "type": "boolean", + "example": true }, - "inherited_allows_public_repositories": { - "type": "boolean" + "has_repository_projects": { + "type": "boolean", + "example": true }, - "allows_public_repositories": { - "type": "boolean" + "public_repos": { + "type": "integer", + "example": 2 }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "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", + "nullable": true + }, + "default_repository_branch": { + "type": "string", + "example": "main", + "nullable": true, + "description": "The default branch for repositories created in this organization." + }, + "members_can_create_repositories": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "two_factor_requirement_enabled": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_delete_repositories": { + "type": "boolean", + "example": true + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "example": true + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "example": true + }, + "members_can_delete_issues": { + "type": "boolean", + "example": true + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "example": true + }, + "readers_can_create_discussions": { + "type": "boolean", + "example": true + }, + "members_can_create_teams": { + "type": "boolean", + "example": true + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "example": false, + "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", + "example": "https://github.com/test-org/test-repo/blob/main/README.md", + "nullable": true, + "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ + "login", + "url", "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "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": { + "default-response": { "value": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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" } } } @@ -57478,22 +55143,22 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" } }, "patch": { - "summary": "Update a self-hosted runner group for an organization", - "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/update-self-hosted-runner-group-for-org", + "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/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -57504,71 +55169,174 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { - "required": true, + "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": { - "description": "Name of the runner group.", - "type": "string" + "type": "string", + "description": "The shorthand name of the company." }, - "visibility": { - "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", + "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": [ - "selected", "all", - "private" + "private", + "none" ] }, - "allows_public_repositories": { - "description": "Whether the runner group can be used by `public` repositories.", + "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 }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "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 }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "blog": { + "type": "string", + "example": "\"http://github.blog\"" }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", + "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", - "nullable": true + "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": [ - "name" - ] + } }, "examples": { "default": { "value": { - "name": "Expensive hardware runners", - "visibility": "selected" + "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" } } } @@ -57581,178 +55349,893 @@ "content": { "application/json": { "schema": { + "title": "Organization Full", + "description": "Organization Full", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, "id": { - "type": "number" + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, "name": { - "type": "string" + "type": "string", + "example": "github" }, - "visibility": { - "type": "string" + "company": { + "type": "string", + "example": "GitHub" }, - "default": { - "type": "boolean" + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "location": { + "type": "string", + "example": "San Francisco" }, - "runners_url": { - "type": "string" + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" }, - "hosted_runners_url": { - "type": "string" + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "is_verified": { + "type": "boolean", + "example": true }, - "inherited": { - "type": "boolean" + "has_organization_projects": { + "type": "boolean", + "example": true }, - "inherited_allows_public_repositories": { - "type": "boolean" + "has_repository_projects": { + "type": "boolean", + "example": true }, - "allows_public_repositories": { - "type": "boolean" + "public_repos": { + "type": "integer", + "example": 2 }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "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", + "nullable": true + }, + "default_repository_branch": { + "type": "string", + "example": "main", + "nullable": true, + "description": "The default branch for repositories created in this organization." + }, + "members_can_create_repositories": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "two_factor_requirement_enabled": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_delete_repositories": { + "type": "boolean", + "example": true + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "example": true + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "example": true + }, + "members_can_delete_issues": { + "type": "boolean", + "example": true + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "example": true + }, + "readers_can_create_discussions": { + "type": "boolean", + "example": true + }, + "members_can_create_teams": { + "type": "boolean", + "example": true + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "example": false, + "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", + "example": "https://github.com/test-org/test-repo/blob/main/README.md", + "nullable": true, + "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ + "login", + "url", "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "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": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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 } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - }, - "delete": { - "summary": "Delete a self-hosted runner group from an organization", - "description": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/delete-self-hosted-runner-group-from-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - } - }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { - "get": { - "summary": "List GitHub-hosted runners in a group for an organization", - "description": "Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-github-hosted-runners-in-group-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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/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": "integer" + "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/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" + } + }, + { + "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": { + "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", + "example": "octo-org/Hello-World" + }, + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", + "example": 2322142 + }, + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", + "example": 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": "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/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" } }, { @@ -57787,7 +56270,7 @@ ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "runners": { "type": "array", @@ -58027,24 +56510,22 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - } - }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { - "get": { - "summary": "List repository access to a self-hosted runner group in an organization", - "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + }, + "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/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -58055,982 +56536,276 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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 - } - }, - { - "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 - } } ], + "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": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "number" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 }, - "repositories": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true }, - "role_name": { + "prefix": { + "description": "The prefix for the public IP.", "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 + "example": "20.80.208.150" }, - "watchers": { + "length": { + "description": "The length of the IP prefix.", "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "example": 28 } - }, - "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" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true } - } + }, + "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 - }, - "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 - }, - "template_repository": { - "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", - "organization": null, - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "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 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": 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==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 } - ] + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -59042,19 +56817,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "put": { - "summary": "Set repository access for a self-hosted runner group in an organization", - "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", + } + }, + "/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/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -59065,74 +56842,105 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "description": "List of repository IDs that can access the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." + "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", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } } } }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 32, - 91 - ] + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { - "put": { - "summary": "Add repository access to a self-hosted runner group in an organization", - "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "/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/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -59143,48 +56951,105 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "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", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 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" + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "delete": { - "summary": "Remove repository access to a self-hosted runner group in an organization", - "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", + } + }, + "/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/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -59195,50 +57060,75 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "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.", + "example": 50 + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "example": 17 + } + }, + "required": [ + "maximum", + "current_usage" + ] + } + }, + "required": [ + "public_ips" + ] + }, + "examples": { + "default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "/orgs/{org}/actions/hosted-runners/machine-sizes": { "get": { - "summary": "List self-hosted runners in a group for an organization", - "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "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/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" }, "parameters": [ { @@ -59249,33 +57139,6 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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": { @@ -59287,87 +57150,45 @@ "type": "object", "required": [ "total_count", - "runners" + "machine_specs" ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, - "runners": { + "machine_specs": { "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "example": "8-core" }, - "runner_group_id": { - "description": "The ID of the runner group.", + "cpu_cores": { + "description": "The number of cores.", "type": "integer", - "example": 1 + "example": 8 }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 } }, "required": [ "id", - "name", - "os", - "status", - "busy", - "labels" + "cpu_cores", + "memory_gb", + "storage_gb" ] } } @@ -59376,96 +57197,36 @@ "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] - }, - { - "id": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - ] + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "put": { - "summary": "Set self-hosted runners in a group for an organization", - "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-in-group-for-org", + } + }, + "/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/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -59476,74 +57237,65 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "runners": { - "description": "List of runner IDs to add to the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." + "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" + } } } }, - "required": [ - "runners" - ] - }, - "examples": { - "default": { - "value": { - "runners": [ - 9, - 2 - ] + "examples": { + "default": { + "value": { + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { - "put": { - "summary": "Add a self-hosted runner to a group for an organization", - "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/add-self-hosted-runner-to-group-for-org", + "/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/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -59556,17 +57308,8 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -59575,27 +57318,233 @@ } ], "responses": { - "204": { - "description": "Response" + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } }, - "delete": { - "summary": "Remove a self-hosted runner from a group for an organization", - "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/remove-self-hosted-runner-from-group-for-org", + "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/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -59608,17 +57557,8 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -59626,40 +57566,266 @@ } } ], + "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" + } + } + }, + "examples": { + "default": { + "value": { + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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" + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - } - }, - "/orgs/{org}/actions/runners": { - "get": { - "summary": "List self-hosted runners for an organization", - "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + }, + "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": [ "actions" ], - "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ - { - "name": "name", - "description": "The name of a self-hosted runner.", - "in": "query", - "schema": { - "type": "string" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -59670,214 +57836,237 @@ } }, { - "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", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], "responses": { - "200": { + "202": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "total_count", - "runners" - ], "properties": { - "total_count": { - "type": "integer" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 }, - "runners": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true }, - "status": { - "description": "The status of the runner.", + "prefix": { + "description": "The prefix for the public IP.", "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } + "example": "20.80.208.150" }, - "ephemeral": { - "type": "boolean" + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true } - } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] }, "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] - }, + "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": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] + "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, + "enabledForGitHubApps": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runners/downloads": { + "/orgs/{org}/actions/oidc/customization/sub": { "get": { - "summary": "List runner applications for an organization", - "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "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": [ - "actions" + "oidc" ], - "operationId": "actions/list-runner-applications-for-org", + "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" + "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -59892,78 +58081,34 @@ ], "responses": { "200": { - "description": "Response", + "description": "A JSON serialized template for OIDC subject claim customization", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Runner Application", - "description": "Runner Application", - "type": "object", - "properties": { - "os": { - "type": "string" - }, - "architecture": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "filename": { - "type": "string" - }, - "temp_download_token": { - "description": "A short lived bearer token used to download the runner, if needed.", - "type": "string" - }, - "sha256_checksum": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", + "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" } - }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] - } + } + }, + "required": [ + "include_claim_keys" + ] }, "examples": { "default": { - "value": [ - { - "os": "osx", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", - "filename": "actions-runner-osx-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", - "filename": "actions-runner-linux-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "arm", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm-2.164.0.tar.gz" - }, - { - "os": "win", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", - "filename": "actions-runner-win-x64-2.164.0.zip" - }, - { - "os": "linux", - "architecture": "arm64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" - } - ] + "value": { + "include_claim_keys": [ + "repo", + "context" + ] + } } } } @@ -59971,24 +58116,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "oidc" } - } - }, - "/orgs/{org}/actions/runners/generate-jitconfig": { - "post": { - "summary": "Create configuration for a just-in-time runner for an organization", - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + }, + "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.", "tags": [ - "actions" + "oidc" ], - "operationId": "actions/generate-runner-jitconfig-for-org", + "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -60006,49 +58148,29 @@ "content": { "application/json": { "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", - "required": [ - "name", - "runner_group_id", - "labels" - ], "properties": { - "name": { - "type": "string", - "description": "The name of the new runner." - }, - "runner_group_id": { - "type": "integer", - "description": "The ID of the runner group to register the runner to." - }, - "labels": { + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", "type": "array", - "minItems": 1, - "maxItems": 100, "items": { "type": "string" - }, - "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." - }, - "work_folder": { - "type": "string", - "description": "The working directory to be used for job execution, relative to the runner install directory.", - "default": "_work" + } } - } + }, + "required": [ + "include_claim_keys" + ] }, "examples": { "default": { "value": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -60057,131 +58179,19 @@ }, "responses": { "201": { - "description": "Response", + "description": "Empty response", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "required": [ - "runner", - "encoded_jit_config" - ], - "properties": { - "runner": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - }, - "encoded_jit_config": { - "type": "string", - "description": "The base64 encoded runner configuration." - } - } + "properties": {}, + "additionalProperties": false }, "examples": { "default": { - "value": { - "runner": { - "id": 23, - "name": "New runner", - "os": "unknown", - "status": "offline", - "busy": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - }, - "encoded_jit_config": "abc123" - } + "value": null } } } @@ -60213,18 +58223,14 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -60232,37 +58238,94 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - }, - "409": { - "description": "Conflict", + } + }, + "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", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" + "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" + ] }, - "documentation_url": { - "type": "string" + "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`." }, - "url": { - "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" + ] }, - "status": { - "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" } } } @@ -60271,24 +58334,99 @@ } }, "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": "self-hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runners/registration-token": { - "post": { - "summary": "Create a registration token for an organization", - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/orgs/{org}/actions/permissions/repositories": { + "get": { + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\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" ], - "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -60299,38 +58437,42 @@ "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": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", + "required": [ + "total_count", + "repositories" + ], "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "example": "v1.1f699f1069f60xxx" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "example": "2016-07-11T22:14:10Z" - }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - } + "total_count": { + "type": "number" }, "repositories": { - "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", @@ -61061,57 +59203,319 @@ "updated_at" ] } - }, - "single_file": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] } - }, - "required": [ - "token", - "expires_at" - ] + } }, "examples": { "default": { "value": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" + "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 + } + ] + } + } + } + } + } + } + }, + "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", + "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" + }, + "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": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." } } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] + } } } } } }, "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\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/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "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", + "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" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runners/remove-token": { - "post": { - "summary": "Create a remove token for an organization", - "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/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" ], - "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -61125,138 +59529,1459 @@ } ], "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "example": "v1.1f699f1069f60xxx" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "example": "2016-07-11T22:14:10Z" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - } + "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." }, - "repositories": { - "description": "The repositories this token has access to", + "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": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "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": { + "type": "string" + } + } + } + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/workflow": { + "get": { + "summary": "Get default workflow permissions for an organization", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-github-actions-default-workflow-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-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": { + "default_workflow_permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] + }, + "can_approve_pull_request_reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + } + }, + "required": [ + "default_workflow_permissions", + "can_approve_pull_request_reviews" + ] + }, + "examples": { + "default": { + "summary": "Give read-only permission, and allow approving PRs.", + "value": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set default workflow permissions for an organization", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-github-actions-default-workflow-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-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": "Success response" + } + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_workflow_permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] + }, + "can_approve_pull_request_reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + } + } + }, + "examples": { + "default": { + "summary": "Give read-only permission, and allow approving PRs.", + "value": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an organization", + "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runner-groups-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-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/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 + } + }, + { + "name": "visible_to_repository", + "description": "Only return runner groups that are allowed to be used by this repository.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runner_groups" + ], + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [], + "workflow_restrictions_read_only": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": true, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "post": { + "summary": "Create a self-hosted runner group for an organization", + "description": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-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 group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an organization", + "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "patch": { + "summary": "Update a self-hosted runner group for an organization", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ] + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an organization", + "description": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + "get": { + "summary": "List GitHub-hosted runners in a group for an organization", + "description": "Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-github-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "number" + }, + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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 + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + "get": { + "summary": "List repository access to a self-hosted runner group in an organization", + "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, "email": { "nullable": true, @@ -61374,8 +61099,6 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -61470,8 +61193,7 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "type": "string" }, "issue_comment_url": { "type": "string", @@ -61520,8 +61242,7 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "type": "string" }, "stargazers_url": { "type": "string", @@ -61557,13 +61278,10 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "type": "string" }, "mirror_url": { "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -61572,14 +61290,10 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "type": "string" }, "homepage": { "type": "string", - "format": "uri", - "example": "https://github.com", "nullable": true }, "language": { @@ -61587,36 +61301,26 @@ "nullable": true }, "forks_count": { - "type": "integer", - "example": 9 + "type": "integer" }, "stargazers_count": { - "type": "integer", - "example": 80 + "type": "integer" }, "watchers_count": { - "type": "integer", - "example": 80 + "type": "integer" }, "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", - "example": 108 + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" + "type": "string" }, "open_issues_count": { - "type": "integer", - "example": 0 + "type": "integer" }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true + "type": "boolean" }, "topics": { "type": "array", @@ -61625,51 +61329,30 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true + "type": "boolean" }, "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true + "type": "boolean" }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "type": "boolean" }, "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", "type": "string" }, "pushed_at": { @@ -61690,122 +61373,214 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" }, "temp_clone_token": { "type": "string" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false + "type": "boolean" }, - "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", - "example": false + "subscribers_count": { + "type": "integer" }, - "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 + "network_count": { + "type": "integer" }, - "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)." + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] }, - "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." + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true }, - "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)." + "forks": { + "type": "integer", + "example": 0 }, - "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." + "open_issues": { + "type": "integer", + "example": 0 }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true + "watchers": { + "type": "integer", + "example": 0 }, "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", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "example": false }, - "code_search_index_status": { + "security_and_analysis": { + "nullable": true, "type": "object", - "description": "The status of the code search index for this repository", "properties": { - "lexical_search_ok": { - "type": "boolean" + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "lexical_commit_sha": { - "type": "string" + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -61854,292 +61629,259 @@ "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" + "url" ] } - }, - "single_file": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - } - }, - "required": [ - "token", - "expires_at" - ] - }, - "examples": { - "default": { - "value": { - "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-29T12:13:35.123-08:00" } } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/orgs/{org}/actions/runners/{runner_id}": { - "get": { - "summary": "Get a self-hosted runner for an organization", - "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/get-self-hosted-runner-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-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" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] }, "examples": { "default": { "value": { - "id": 23, - "name": "MBP", - "os": "macos", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, + "total_count": 1, + "repositories": [ { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - }, - "delete": { - "summary": "Delete a self-hosted runner from an organization", - "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-self-hosted-runner-from-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "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" - } + "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 + }, + "template_repository": { + "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", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "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 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": 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==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] } } } @@ -62148,24 +61890,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - } - }, - "/orgs/{org}/actions/runners/{runner_id}/labels": { - "get": { - "summary": "List labels for a self-hosted runner for an organization", - "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + }, + "put": { + "summary": "Set repository access for a self-hosted runner group in an organization", + "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], - "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -62178,8 +61918,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -62187,128 +61927,115 @@ } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." } } }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 91 + ] } } } } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + "put": { + "summary": "Add repository access to a self-hosted runner group in an organization", + "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "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" - } - } - } - } + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } + ], + "responses": { + "204": { + "description": "Response" + } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } }, - "post": { - "summary": "Add custom labels to a self-hosted runner for an organization", - "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "delete": { + "summary": "Remove repository access to a self-hosted runner group in an organization", + "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], - "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -62321,8 +62048,17 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { @@ -62330,40 +62066,69 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "labels" - ], - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "maxItems": 100, - "description": "The names of the custom labels to add to the runner.", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "labels": [ - "gpu", - "accelerated" - ] - } - } - } - } + "responses": { + "204": { + "description": "Response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an organization", + "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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", @@ -62373,38 +62138,87 @@ "type": "object", "required": [ "total_count", - "labels" + "runners" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "labels": { + "runners": { "type": "array", "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { "id": { + "description": "The ID of the runner.", "type": "integer", - "description": "Unique identifier of the label." + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 }, "name": { + "description": "The name of the runner.", "type": "string", - "description": "Name of the label." + "example": "iMac" }, - "type": { + "os": { + "description": "The Operating System of the runner.", "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } }, "required": [ - "name" + "id", + "name", + "os", + "status", + "busy", + "labels" ] } } @@ -62413,109 +62227,96 @@ "examples": { "default": { "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, + "total_count": 2, + "runners": [ { - "id": 20, - "name": "macOS", - "type": "read-only" + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] }, { - "id": 21, - "name": "no-gpu", - "type": "custom" + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } ] } } } } - } - }, - "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": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "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" - } - } - } + "type": "string" } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } }, "put": { - "summary": "Set custom labels for a self-hosted runner for an organization", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "Set self-hosted runners in a group for an organization", + "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-in-group-for-org", "tags": [ "actions" ], - "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -62528,8 +62329,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -62543,27 +62344,26 @@ "application/json": { "schema": { "type": "object", - "required": [ - "labels" - ], "properties": { - "labels": { + "runners": { + "description": "List of runner IDs to add to the runner group.", "type": "array", - "minItems": 0, - "maxItems": 100, - "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", "items": { - "type": "string" + "type": "integer", + "description": "Unique identifier of the runner." } } - } + }, + "required": [ + "runners" + ] }, "examples": { "default": { "value": { - "labels": [ - "gpu", - "accelerated" + "runners": [ + 9, + 2 ] } } @@ -62572,157 +62372,29 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - }, - "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 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" - } - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - }, - "delete": { - "summary": "Remove all custom labels from a self-hosted runner for an organization", - "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an organization", + "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-self-hosted-runner-to-group-for-org", "tags": [ "actions" ], - "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" }, "parameters": [ { @@ -62734,6 +62406,15 @@ "type": "string" } }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", @@ -62745,124 +62426,27 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 3, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - } - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - } - }, - "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + }, "delete": { - "summary": "Remove a custom label from a self-hosted runner for an organization", - "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "Remove a self-hosted runner from a group for an organization", + "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-self-hosted-runner-from-group-for-org", "tags": [ "actions" ], - "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" }, "parameters": [ { @@ -62875,8 +62459,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -62884,171 +62468,49 @@ } }, { - "name": "name", - "description": "The name of a self-hosted runner's custom label.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - }, - "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 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" - } - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/orgs/{org}/actions/secrets": { + "/orgs/{org}/actions/runners": { "get": { - "summary": "List organization secrets", - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "List self-hosted runners for an organization", + "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/list-org-secrets", + "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#list-organization-secrets" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" }, "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -63086,52 +62548,87 @@ "type": "object", "required": [ "total_count", - "secrets" + "runners" ], "properties": { "total_count": { "type": "integer" }, - "secrets": { + "runners": { "type": "array", "items": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" + "description": "The name of the runner.", + "type": "string", + "example": "iMac" }, - "created_at": { + "os": { + "description": "The Operating System of the runner.", "type": "string", - "format": "date-time" + "example": "macos" }, - "updated_at": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "date-time" + "example": "online" }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" + "busy": { + "type": "boolean" }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } }, "required": [ + "id", "name", - "created_at", - "updated_at", - "visibility" + "os", + "status", + "busy", + "labels" ] } } @@ -63140,26 +62637,62 @@ "examples": { "default": { "value": { - "total_count": 3, - "secrets": [ - { - "name": "GIST_ID", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, + "total_count": 2, + "runners": [ { - "name": "DEPLOY_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] }, { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } ] } @@ -63181,21 +62714,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/public-key": { + "/orgs/{org}/actions/runners/downloads": { "get": { - "summary": "Get an organization public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "summary": "List runner applications for an organization", + "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/get-org-public-key", + "operationId": "actions/list-runner-applications-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" }, "parameters": [ { @@ -63214,48 +62747,74 @@ "content": { "application/json": { "schema": { - "title": "ActionsPublicKey", - "description": "The public key used for setting Actions Secrets.", - "type": "object", - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "example": "1234567" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - }, - "id": { - "type": "integer", - "example": 2 - }, - "url": { - "type": "string", - "example": "https://api.github.com/user/keys/2" - }, - "title": { - "type": "string", - "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + "type": "array", + "items": { + "title": "Runner Application", + "description": "Runner Application", + "type": "object", + "properties": { + "os": { + "type": "string" + }, + "architecture": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "temp_download_token": { + "description": "A short lived bearer token used to download the runner, if needed.", + "type": "string" + }, + "sha256_checksum": { + "type": "string" + } }, - "created_at": { - "type": "string", - "example": "2011-01-26T19:01:12Z" - } - }, - "required": [ - "key_id", - "key" - ] + "required": [ + "os", + "architecture", + "download_url", + "filename" + ] + } }, "examples": { "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } + "value": [ + { + "os": "osx", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", + "filename": "actions-runner-osx-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", + "filename": "actions-runner-linux-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "arm", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm-2.164.0.tar.gz" + }, + { + "os": "win", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", + "filename": "actions-runner-win-x64-2.164.0.zip" + }, + { + "os": "linux", + "architecture": "arm64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" + } + ] } } } @@ -63266,119 +62825,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/orgs/{org}/actions/runners/generate-jitconfig": { + "post": { + "summary": "Create configuration for a just-in-time runner for an organization", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/create-or-update-org-secret", + "operationId": "actions/generate-runner-jitconfig-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" }, "parameters": [ { @@ -63389,15 +62850,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -63406,49 +62858,48 @@ "application/json": { "schema": { "type": "object", + "required": [ + "name", + "runner_group_id", + "labels" + ], "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { + "name": { "type": "string", - "description": "ID of the key you used to encrypt the secret." + "description": "The name of the new runner." }, - "visibility": { - "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "enum": [ - "all", - "private", - "selected" - ] + "runner_group_id": { + "type": "integer", + "description": "The ID of the runner group to register the runner to." }, - "selected_repository_ids": { + "labels": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "minItems": 1, + "maxItems": 100, "items": { - "type": "integer" - } + "type": "string" + }, + "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." + }, + "work_folder": { + "type": "string", + "description": "The working directory to be used for job execution, relative to the runner install directory.", + "default": "_work" } - }, - "required": [ - "encrypted_value", - "key_id", - "visibility" - ] + } }, "examples": { "default": { "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" } } } @@ -63457,90 +62908,238 @@ }, "responses": { "201": { - "description": "Response when creating a secret", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } }, "examples": { "default": { - "value": null + "value": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + } } } } } }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "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" + } + } + } + } } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } } - } - ], - "responses": { - "204": { - "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/{secret_name}/repositories": { - "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "/orgs/{org}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for an organization", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/list-selected-repos-for-org-secret", + "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" }, "parameters": [ { @@ -63551,79 +63150,138 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 - } } ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } }, "repositories": { + "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { "nullable": true, "type": "string" @@ -63744,6 +63402,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -63838,7 +63498,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string" + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", @@ -63887,7 +63548,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string" + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", @@ -63923,10 +63585,13 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string" + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -63935,10 +63600,14 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", + "format": "uri", + "example": "https://github.com", "nullable": true }, "language": { @@ -63946,26 +63615,36 @@ "nullable": true }, "forks_count": { - "type": "integer" + "type": "integer", + "example": 9 }, "stargazers_count": { - "type": "integer" + "type": "integer", + "example": 80 }, "watchers_count": { - "type": "integer" + "type": "integer", + "example": 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" + "type": "integer", + "example": 108 }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "example": "master" }, "open_issues_count": { - "type": "integer" + "type": "integer", + "example": 0 }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true }, "topics": { "type": "array", @@ -63974,30 +63653,51 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -64018,214 +63718,122 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, "delete_branch_on_merge": { - "type": "boolean" + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "subscribers_count": { - "type": "integer" + "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", + "example": false }, - "network_count": { - "type": "integer" + "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 }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] + "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)." }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true + "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." }, - "forks": { - "type": "integer", - "example": 0 + "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)." }, - "open_issues": { - "type": "integer", - "example": 0 + "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." }, - "watchers": { - "type": "integer", - "example": 0 + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": 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", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { "type": "boolean", - "example": false + "description": "Whether anonymous git access is enabled for this repository" }, - "security_and_analysis": { - "nullable": true, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_search_ok": { + "type": "boolean" }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_commit_sha": { + "type": "string" } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ @@ -64274,809 +63882,87 @@ "tags_url", "teams_url", "trees_url", - "url" - ] - } - } - } - }, - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/set-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "integer" - } - } - }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/add-selected-repo-to-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "No Content when repository was added to the selected list" - }, - "409": { - "description": "Conflict when visibility type is not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/remove-selected-repo-from-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response when repository was removed from the selected list" - }, - "409": { - "description": "Conflict when visibility type not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/actions/variables": { - "get": { - "summary": "List organization variables", - "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/list-org-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#list-organization-variables" - }, - "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 30). 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": 10 - } - }, - { - "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": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "example": "USERNAME", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "example": "octocat", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a variable", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" - } - }, - "required": [ - "name", - "value", + "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", - "visibility" + "updated_at" ] } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 3, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "ACTIONS_RUNNER_DEBUG", - "value": true, - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "ADMIN_EMAIL", - "value": "octocat@github.com", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "post": { - "summary": "Create an organization variable", - "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/create-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#create-an-organization-variable" - }, - "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": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - }, - "visibility": { - "type": "string", - "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", - "items": { - "type": "integer" - } - } - }, - "required": [ - "name", - "value", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a variable", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - } - }, - "/orgs/{org}/actions/variables/{name}": { - "get": { - "summary": "Get an organization variable", - "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#get-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "example": "USERNAME", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "example": "octocat", - "type": "string" }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", + "single_file": { "type": "string", - "format": "date-time" + "example": "config.yaml", + "nullable": true }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a variable", "enum": [ "all", - "private", "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" + ] } }, "required": [ - "name", - "value", - "created_at", - "updated_at", - "visibility" + "token", + "expires_at" ] }, "examples": { "default": { "value": { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "patch": { - "summary": "Update an organization variable", - "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/update-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#update-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - }, - "visibility": { - "type": "string", - "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", - "items": { - "type": "integer" + "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-22T12:13:35.123-08:00" } } } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "delete": { - "summary": "Delete an organization variable", - "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#delete-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/variables/{name}/repositories": { - "get": { - "summary": "List selected repositories for an organization variable", - "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "/orgs/{org}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for an organization", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/list-selected-repos-for-org-variable", + "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" }, "parameters": [ { @@ -65087,74 +63973,133 @@ "schema": { "type": "string" } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 - } } ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } }, "repositories": { + "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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.", @@ -65280,6 +64225,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -65374,7 +64321,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string" + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", @@ -65423,7 +64371,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string" + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", @@ -65459,10 +64408,13 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string" + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -65471,10 +64423,14 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", + "format": "uri", + "example": "https://github.com", "nullable": true }, "language": { @@ -65482,26 +64438,36 @@ "nullable": true }, "forks_count": { - "type": "integer" + "type": "integer", + "example": 9 }, "stargazers_count": { - "type": "integer" + "type": "integer", + "example": 80 }, "watchers_count": { - "type": "integer" + "type": "integer", + "example": 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" + "type": "integer", + "example": 108 }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "example": "master" }, "open_issues_count": { - "type": "integer" + "type": "integer", + "example": 0 }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true }, "topics": { "type": "array", @@ -65510,30 +64476,51 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -65554,214 +64541,122 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, "delete_branch_on_merge": { - "type": "boolean" + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "subscribers_count": { - "type": "integer" + "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", + "example": false }, - "network_count": { - "type": "integer" + "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 }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] + "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)." }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true + "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." }, - "forks": { - "type": "integer", - "example": 0 + "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)." }, - "open_issues": { - "type": "integer", - "example": 0 + "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." }, - "watchers": { - "type": "integer", - "example": 0 + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": 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", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { "type": "boolean", - "example": false + "description": "Whether anonymous git access is enabled for this repository" }, - "security_and_analysis": { - "nullable": true, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_search_ok": { + "type": "boolean" }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_commit_sha": { + "type": "string" } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ @@ -65810,114 +64705,87 @@ "tags_url", "teams_url", "trees_url", - "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" ] } + }, + "single_file": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] } - } + }, + "required": [ + "token", + "expires_at" + ] }, "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] + "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-29T12:13:35.123-08:00" } } } } } - }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - }, - "put": { - "summary": "Set selected repositories for an organization variable", - "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for an organization", + "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/set-selected-repos-for-org-variable", + "operationId": "actions/get-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -65930,73 +64798,150 @@ } }, { - "name": "name", - "description": "The name of the variable.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "The IDs of the repositories that can access the organization variable.", - "items": { - "type": "integer" + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } - } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] + "examples": { + "default": { + "value": { + "id": 23, + "name": "MBP", + "os": "macos", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } } } } } } }, - "responses": { - "204": { - "description": "Response" - }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" - } - }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization variable", - "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + }, + "delete": { + "summary": "Delete a self-hosted runner from an organization", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/add-selected-repo-to-org-variable", + "operationId": "actions/delete-self-hosted-runner-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" }, "parameters": [ { @@ -66009,16 +64954,8 @@ } }, { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { @@ -66030,27 +64967,56 @@ "204": { "description": "Response" }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" - } - }, - "x-github": { - "githubCloudOnly": false, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - }, - "delete": { - "summary": "Remove selected repository from an organization variable", - "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runners/{runner_id}/labels": { + "get": { + "summary": "List labels for a self-hosted runner for an organization", + "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/remove-selected-repo-from-org-variable", + "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66063,16 +65029,8 @@ } }, { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { @@ -66081,68 +65039,145 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + } + } + } + } }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" + "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": "variables" + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/attestations/bulk-list": { + }, "post": { - "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "summary": "Add custom labels to a self-hosted runner for an organization", + "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-attestations-bulk", + "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#list-attestations-by-bulk-subject-digests" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" }, "parameters": [ { - "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": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -66152,42 +65187,29 @@ "application/json": { "schema": { "type": "object", + "required": [ + "labels" + ], "properties": { - "subject_digests": { + "labels": { "type": "array", + "minItems": 1, + "maxItems": 100, + "description": "The names of the custom labels to add to the runner.", "items": { "type": "string" - }, - "description": "List of subject digests to fetch attestations for.", - "minItems": 1, - "maxItems": 1024 - }, - "predicate_type": { - "type": "string", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types." + } } - }, - "required": [ - "subject_digests" - ] + } }, "examples": { "default": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" + "labels": [ + "gpu", + "accelerated" ] } - }, - "withPredicateType": { - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ], - "predicateType": "provenance" - } } } } @@ -66200,198 +65222,69 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "attestations_subject_digests": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "array", - "items": { - "type": "object", - "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The bundle of the attestation." - }, - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - } - } - } - }, - "description": "Mapping of subject digest to bundles." + "total_count": { + "type": "integer" }, - "page_info": { - "type": "object", - "properties": { - "has_next": { - "type": "boolean", - "description": "Indicates whether there is a next page." - }, - "has_previous": { - "type": "boolean", - "description": "Indicates whether there is a previous page." - }, - "next": { - "type": "string", - "description": "The cursor to the next page." + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } }, - "previous": { - "type": "string", - "description": "The cursor to the previous page." - } - }, - "description": "Information about the current page." + "required": [ + "name" + ] + } } } }, "examples": { "default": { "value": { - "attestations_subject_digests": [ + "total_count": 4, + "labels": [ { - "sha256:abc": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" } ] } @@ -66399,27 +65292,81 @@ } } } + }, + "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 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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/attestations/delete-request": { - "post": { - "summary": "Delete attestations in bulk", - "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + }, + "put": { + "summary": "Set custom labels for a self-hosted runner for an organization", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-attestations-bulk", + "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66430,6 +65377,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -66438,58 +65394,27 @@ "application/json": { "schema": { "type": "object", - "oneOf": [ - { - "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } - }, - "required": [ - "subject_digests" - ] - }, - { - "properties": { - "attestation_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of unique IDs associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } - }, - "required": [ - "attestation_ids" - ] - } + "required": [ + "labels" ], - "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + "properties": { + "labels": { + "type": "array", + "minItems": 0, + "maxItems": 100, + "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", + "items": { + "type": "string" + } + } + } }, "examples": { - "by-subject-digests": { - "summary": "Delete by subject digests", - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] - } - }, - "by-attestation-ids": { - "summary": "Delete by attestation IDs", + "default": { "value": { - "attestation_ids": [ - 111, - 222 + "labels": [ + "gpu", + "accelerated" ] } } @@ -66499,7 +65424,81 @@ }, "responses": { "200": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + } + } + } + } }, "404": { "description": "Resource not found", @@ -66526,27 +65525,55 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" + "category": "actions", + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/attestations/digest/{subject_digest}": { + }, "delete": { - "summary": "Delete attestations by subject digest", - "description": "Delete an artifact attestation by subject digest.", + "summary": "Remove all custom labels from a self-hosted runner for an organization", + "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-attestations-by-subject-digest", + "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66559,22 +65586,87 @@ } }, { - "name": "subject_digest", - "description": "Subject Digest", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } } ], "responses": { "200": { - "description": "Response" - }, - "204": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + } + ] + } + } + } + } + } }, "404": { "description": "Resource not found", @@ -66606,22 +65698,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" + "category": "actions", + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/attestations/{attestation_id}": { + "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { "delete": { - "summary": "Delete attestations by ID", - "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.", + "summary": "Remove a custom label from a self-hosted runner for an organization", + "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-attestations-by-id", + "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66634,24 +65726,104 @@ } }, { - "name": "attestation_id", - "description": "Attestation ID", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } + }, + { + "name": "name", + "description": "The name of a self-hosted runner's custom label.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "Response" - }, - "204": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + } + } + } + } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -66676,14 +65848,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -66691,11 +65867,11 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -66706,51 +65882,24 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" + "category": "actions", + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/attestations/{subject_digest}": { + "/orgs/{org}/actions/secrets": { "get": { - "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-attestations", + "operationId": "actions/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#list-attestations" + "url": "https://docs.github.com/rest/actions/secrets#list-organization-secrets" }, "parameters": [ - { - "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": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -66761,22 +65910,21 @@ } }, { - "name": "subject_digest", - "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", - "in": "path", - "required": true, + "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": "string" - }, - "x-multi-segment": true + "type": "integer", + "default": 30 + } }, { - "name": "predicate_type", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "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", - "required": false, "schema": { - "type": "string" + "type": "integer", + "default": 1 } } ], @@ -66787,38 +65935,55 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "secrets" + ], "properties": { - "attestations": { + "total_count": { + "type": "integer" + }, + "secrets": { "type": "array", "items": { + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" }, - "repository_id": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time" }, - "bundle_url": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" } - } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] } } } @@ -66826,156 +65991,62 @@ "examples": { "default": { "value": { - "attestations": [ + "total_count": 3, + "secrets": [ { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 + "name": "GIST_ID", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" }, { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 + "name": "DEPLOY_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } ] } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/blocks": { + "/orgs/{org}/actions/secrets/public-key": { "get": { - "summary": "List users blocked by an organization", - "description": "List the users blocked by an organization.", + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-blocked-users", + "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization" + "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -66986,24 +66057,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": { @@ -67012,156 +66065,48 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" }, - "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" - ] - } + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] }, "examples": { "default": { - "value": [ - { - "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 - } - ] + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } } } } @@ -67171,22 +66116,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/blocks/{username}": { + "/orgs/{org}/actions/secrets/{secret_name}": { "get": { - "summary": "Check if a user is blocked by an organization", - "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/check-blocked-user", + "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-secret" }, "parameters": [ { @@ -67199,8 +66144,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -67209,29 +66154,58 @@ } ], "responses": { - "204": { - "description": "If the user is blocked" - }, - "404": { - "description": "If the user is not blocked", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", "type": "string" }, - "documentation_url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time" }, - "status": { + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } } } @@ -67242,20 +66216,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } }, "put": { - "summary": "Block a user from an organization", - "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/block-user", + "operationId": "actions/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization" + "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -67268,8 +66242,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -67277,97 +66251,102 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "encrypted_value", + "key_id", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "201": { + "description": "Response when creating a secret", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Empty Object", + "description": "An object without any properties.", "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null } } } } + }, + "204": { + "description": "Response when updating a secret" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } }, "delete": { - "summary": "Unblock a user from an organization", - "description": "Unblocks the given user on behalf of the specified organization.", + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/unblock-user", + "operationId": "actions/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization" + "url": "https://docs.github.com/rest/actions/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -67380,8 +66359,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -67397,22 +66376,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/campaigns": { + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { "get": { - "summary": "List campaigns for an organization", - "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "campaigns" + "actions" ], - "operationId": "campaigns/list-org-campaigns", + "operationId": "actions/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization" + "url": "https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -67424,6 +66403,15 @@ "type": "string" } }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "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).\"", @@ -67441,51 +66429,6 @@ "type": "integer", "default": 30 } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "state", - "description": "If specified, only campaigns with this state will be returned.", - "in": "query", - "required": false, - "schema": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - } - }, - { - "name": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "ends_at", - "published" - ], - "default": "created" - } } ], "responses": { @@ -67494,1780 +66437,775 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 }, - "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } + "email": { + "nullable": true, + "type": "string" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" + "private": { + "type": "boolean" }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] - } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - { - "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 - } - ], - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open" - }, - { - "number": 4, - "created_at": "2024-03-30T12:29:18Z", - "updated_at": "2024-03-30T12:29:18Z", - "name": "Mitre top 10 KEV", - "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.", - "managers": [ - { - "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 - } - ], - "ends_at": "2024-04-30T12:29:18Z", - "closed_at": null, - "state": "open" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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" - } - } - } - } - } - }, - "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": "campaigns", - "subcategory": "campaigns" - } - }, - "post": { - "summary": "Create a campaign for an organization", - "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.", - "tags": [ - "campaigns" - ], - "operationId": "campaigns/create-campaign", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-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", - "additionalProperties": false, - "properties": { - "name": { - "description": "The name of the campaign", - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "description": { - "description": "A description for the campaign", - "type": "string", - "minLength": 1, - "maxLength": 255 - }, - "managers": { - "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", - "type": "array", - "maxItems": 10, - "items": { - "description": "The login of each manager", - "type": "string" - } - }, - "team_managers": { - "description": "The slugs of the teams to set as the campaign managers.", - "type": "array", - "maxItems": 10, - "items": { - "description": "The slug of each team", - "type": "string" - } - }, - "ends_at": { - "description": "The end date and time of the campaign. The date must be in the future.", - "type": "string", - "format": "date-time" - }, - "contact_link": { - "description": "The contact link of the campaign. Must be a URI.", - "type": "string", - "format": "uri", - "nullable": true - }, - "code_scanning_alerts": { - "description": "The code scanning alerts to include in this campaign", - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "additionalProperties": false, - "properties": { - "repository_id": { - "type": "integer", - "description": "The repository id" - }, - "alert_numbers": { - "type": "array", - "description": "The alert numbers", - "minItems": 1, - "items": { - "type": "integer" - } - } - }, - "required": [ - "repository_id", - "alert_numbers" - ] - } - }, - "generate_issues": { - "description": "If true, will automatically generate issues for the campaign. The default is false.", - "type": "boolean", - "default": false - } - }, - "required": [ - "name", - "description", - "ends_at", - "code_scanning_alerts" - ] - }, - "examples": { - "default": { - "value": { - "name": "Critical CodeQL alerts", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - "octocat" - ], - "ends_at": "2024-03-14T00:00:00Z", - "code_scanning_alerts": [ - { - "repository_id": 1296269, - "alert_numbers": [ - 1, - 2 - ] - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "email": { - "nullable": true, - "type": "string" + "fork": { + "type": "boolean" }, - "login": { + "url": { "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "node_id": { + "archive_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "avatar_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "gravatar_id": { + "blobs_url": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "url": { + "branches_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "html_url": { + "collaborators_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "followers_url": { + "comments_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "following_url": { + "commits_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "gists_url": { + "compare_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "starred_url": { + "contents_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "subscriptions_url": { + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "type": { + "git_commits_url": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "starred_at": { + "git_refs_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "user_view_type": { + "git_tags_url": { "type": "string", - "example": "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "slug": { + "git_url": { "type": "string" }, - "description": { + "issue_comment_url": { "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "notification_setting": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "permission": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "url": { + "labels_url": { "type": "string", - "format": "uri" + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "html_url": { + "languages_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "repositories_url": { + "merges_url": { "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] - } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] - }, - "examples": { - "default": { - "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - { - "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 - } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "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": "Unprocessable Entity", - "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" - } - } - } - } - } - }, - "429": { - "description": "Too Many Requests" - }, - "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": "campaigns", - "subcategory": "campaigns" - } - } - }, - "/orgs/{org}/campaigns/{campaign_number}": { - "get": { - "summary": "Get a campaign for an organization", - "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", - "tags": [ - "campaigns" - ], - "operationId": "campaigns/get-campaign-summary", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "campaign_number", - "description": "The campaign number.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "email": { - "nullable": true, - "type": "string" + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "login": { + "notifications_url": { "type": "string", - "example": "octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "node_id": { + "releases_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "avatar_url": { + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "gravatar_id": { + "statuses_url": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "url": { + "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "html_url": { + "subscription_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "followers_url": { + "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "following_url": { + "teams_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "gists_url": { + "trees_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "clone_url": { + "type": "string" }, - "subscriptions_url": { + "mirror_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "nullable": true }, - "organizations_url": { + "hooks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "svn_url": { + "type": "string" }, - "events_url": { + "homepage": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "nullable": true }, - "received_events_url": { + "language": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "nullable": true }, - "type": { - "type": "string", - "example": "User" + "forks_count": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "stargazers_count": { + "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "watchers_count": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "example": "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { + "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" }, - "node_id": { + "default_branch": { "type": "string" }, - "name": { - "type": "string" + "open_issues_count": { + "type": "integer" }, - "slug": { + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { "type": "string" }, - "description": { + "pushed_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", "nullable": true }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true }, - "permission": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true }, "permissions": { "type": "object", "properties": { - "pull": { + "admin": { "type": "boolean" }, - "triage": { + "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, - "maintain": { + "triage": { "type": "boolean" }, - "admin": { + "pull": { "type": "boolean" } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" + } }, - "html_url": { + "role_name": { "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "example": "admin" }, - "members_url": { + "temp_clone_token": { "type": "string" }, - "repositories_url": { - "type": "string", - "format": "uri" + "delete_branch_on_merge": { + "type": "boolean" }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { + "key": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "example": "contributor_covenant" }, "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", "type": "string", - "example": "admin" + "example": "Contributor Covenant" }, - "privacy": { - "description": "The level of privacy this team should have", + "url": { "type": "string", - "example": "closed" + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, - "notification_setting": { - "description": "The notification setting the team has set", + "body": { "type": "string", - "example": "notifications_enabled" + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "name": { + "type": "string" }, - "slug": { - "type": "string", - "example": "justice-league" + "spdx_id": { + "type": "string" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", + "url": { + "type": "string" + }, + "node_id": { "type": "string" } }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "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", - "url", - "members_url", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] + } }, "examples": { "default": { "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ + "total_count": 1, + "repositories": [ { - "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 + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } - } - } - } - } - } - }, - "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": "Unprocessable Entity", - "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" + ] } } } @@ -69278,20 +67216,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "actions", + "subcategory": "secrets" } }, - "patch": { - "summary": "Update a campaign", - "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "campaigns" + "actions" ], - "operationId": "campaigns/update-campaign", + "operationId": "actions/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign" + "url": "https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -69304,12 +67242,12 @@ } }, { - "name": "campaign_number", - "description": "The campaign number.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -69319,63 +67257,25 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": false, "properties": { - "name": { - "description": "The name of the campaign", - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "description": { - "description": "A description for the campaign", - "type": "string", - "minLength": 1, - "maxLength": 255 - }, - "managers": { - "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - } - }, - "team_managers": { - "description": "The slugs of the teams to set as the campaign managers.", + "selected_repository_ids": { "type": "array", - "maxItems": 10, + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { - "description": "The slug of each team", - "type": "string" + "type": "integer" } - }, - "ends_at": { - "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "contact_link": { - "description": "The contact link of the campaign. Must be a URI.", - "type": "string", - "format": "uri", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] } - } + }, + "required": [ + "selected_repository_ids" + ] }, "examples": { "default": { "value": { - "name": "Critical CodeQL alerts" + "selected_repository_ids": [ + 64780797 + ] } } } @@ -69383,546 +67283,380 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - } + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/variables": { + "get": { + "summary": "List organization variables", + "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-org-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-organization-variables" + }, + "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 30). 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": 10 + } + }, + { + "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": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" }, - "team_managers": { - "description": "The campaign team managers", + "variables": { "type": "array", "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, "name": { + "description": "The name of the variable.", + "example": "USERNAME", "type": "string" }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { + "value": { + "description": "The value of the variable.", + "example": "octocat", "type": "string" }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", "type": "string", - "format": "uri" + "format": "date-time" }, - "html_url": { + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "format": "date-time" }, - "members_url": { + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" }, - "repositories_url": { + "selected_repositories_url": { "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true + "format": "uri", + "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" } }, "required": [ - "id", - "node_id", - "url", - "members_url", "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" + "value", + "created_at", + "updated_at", + "visibility" ] } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] + } }, "examples": { "default": { "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ + "total_count": 3, + "variables": [ { - "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 + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "ACTIONS_RUNNER_DEBUG", + "value": true, + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "ADMIN_EMAIL", + "value": "octocat@github.com", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } + ] } } } } - } - }, - "400": { - "description": "Bad Request", - "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" } } } - }, - "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": "variables" + } + }, + "post": { + "summary": "Create an organization variable", + "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#create-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } - }, - "422": { - "description": "Unprocessable Entity", - "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": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + }, + "visibility": { + "type": "string", + "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", + "items": { + "type": "integer" } } + }, + "required": [ + "name", + "value", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } } } } - }, - "503": { - "description": "Service unavailable", + } + }, + "responses": { + "201": { + "description": "Response when creating a variable", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null } } } @@ -69932,20 +67666,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "actions", + "subcategory": "variables" } - }, - "delete": { - "summary": "Delete a campaign for an organization", - "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + } + }, + "/orgs/{org}/actions/variables/{name}": { + "get": { + "summary": "Get an organization variable", + "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "campaigns" + "actions" ], - "operationId": "campaigns/delete-campaign", + "operationId": "actions/get-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization" + "url": "https://docs.github.com/rest/actions/variables#get-an-organization-variable" }, "parameters": [ { @@ -69958,60 +67694,79 @@ } }, { - "name": "campaign_number", - "description": "The campaign number.", + "name": "name", + "description": "The name of the variable.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "204": { - "description": "Deletion successful" - }, - "404": { - "description": "Resource not found", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the variable.", + "example": "USERNAME", "type": "string" }, - "documentation_url": { + "value": { + "description": "The value of the variable.", + "example": "octocat", "type": "string" }, - "url": { - "type": "string" + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", + "type": "string", + "format": "date-time" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", + "type": "string", + "format": "date-time" }, - "message": { + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" }, - "documentation_url": { - "type": "string" + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" } } } @@ -70022,22 +67777,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "actions", + "subcategory": "variables" } - } - }, - "/orgs/{org}/code-scanning/alerts": { - "get": { - "summary": "List code scanning alerts for an organization", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + }, + "patch": { + "summary": "Update an organization variable", + "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "code-scanning" + "actions" ], - "operationId": "code-scanning/list-alerts-for-org", + "operationId": "actions/update-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/rest/actions/variables#update-an-organization-variable" }, "parameters": [ { @@ -70050,40 +67803,147 @@ } }, { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "query", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." + "type": "string" } - }, + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + }, + "visibility": { + "type": "string", + "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Delete an organization variable", + "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#delete-an-organization-variable" + }, + "parameters": [ { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "nullable": true, - "type": "string", - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + "type": "string" } }, { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}/repositories": { + "get": { + "summary": "List selected repositories for an organization variable", + "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { "type": "string" } @@ -70105,69 +67965,6 @@ "type": "integer", "default": 30 } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "state", - "description": "If specified, only code scanning alerts with this state will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" - ] - } - }, - { - "name": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "severity", - "description": "If specified, only code scanning alerts with this severity will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "Severity of a code scanning alert.", - "enum": [ - "critical", - "high", - "medium", - "low", - "warning", - "note", - "error" - ] - } } ], "responses": { @@ -70176,397 +67973,38 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "nullable": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "fixed_at": { - "type": "string", - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "dismissed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "dismissed_at": { - "type": "string", - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "dismissed_reason": { - "type": "string", - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests" - ] - }, - "dismissed_comment": { - "type": "string", - "description": "The dismissal comment associated with the dismissal of the alert.", - "nullable": true, - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "nullable": true, - "type": "string", - "description": "A unique identifier for the rule used to detect the alert." - }, - "name": { - "type": "string", - "description": "The name of the rule used to detect the alert." - }, - "severity": { - "nullable": true, - "type": "string", - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error" - ] - }, - "security_severity_level": { - "nullable": true, - "type": "string", - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - }, - "full_description": { - "type": "string", - "description": "A description of the rule used to detect the alert." - }, - "tags": { - "nullable": true, - "type": "array", - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, - "help": { - "nullable": true, - "type": "string", - "description": "Detailed documentation for the rule as GitHub Flavored Markdown." - }, - "help_uri": { - "nullable": true, - "type": "string", - "description": "A link to the documentation for the rule used to detect the alert." - } - } - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "nullable": true, - "type": "string", - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "nullable": true, - "type": "string", - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - } - }, - "most_recent_instance": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "analysis_key": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." - }, - "environment": { - "type": "string", - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "nullable": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "commit_sha": { - "type": "string" - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "location": { - "type": "object", - "description": "Describe a region within a file for the alert.", - "properties": { - "path": { - "type": "string" - }, - "start_line": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "start_column": { - "type": "integer" - }, - "end_column": { - "type": "integer" - } - } - }, - "html_url": { - "type": "string" - }, - "classifications": { - "type": "array", - "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", - "items": { - "type": "string", - "description": "A classification of the file. For example to identify it as generated.", - "nullable": true, - "enum": [ - "source", - "generated", - "test", - "library" - ] - } - } - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", - "example": "Hello-World", - "description": "The name of the repository." + "example": "Hello-World" }, "full_name": { "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." + "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", @@ -70693,223 +68131,488 @@ ] }, "private": { - "type": "boolean", - "description": "Whether the repository is private." + "type": "boolean" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." + "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true, - "description": "The repository description." + "nullable": true }, "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." + "type": "boolean" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." + "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" }, "issue_comment_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true }, "hooks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -70960,224 +68663,39 @@ "trees_url", "url" ] - }, - "dismissal_approved_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance", - "repository" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "number": 4, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", - "html_url": "https://github.com/octocat/hello-world/code-scanning/4", - "state": "open", - "dismissed_by": null, - "dismissed_at": null, - "dismissed_reason": null, - "dismissed_comment": null, - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", - "repository": { - "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 + } + } + } + }, + "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", @@ -71201,6 +68719,7 @@ "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}", @@ -71212,6 +68731,7 @@ "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", @@ -71219,154 +68739,618 @@ "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}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } + } + } + } + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "put": { + "summary": "Set selected repositories for an organization variable", + "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/set-selected-repos-for-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "The IDs of the repositories that can access the organization variable.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization variable", + "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-selected-repo-to-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Remove selected repository from an organization variable", + "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/attestations/bulk-list": { + "post": { + "summary": "List attestations by bulk subject digests", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-attestations-by-bulk-subject-digests" + }, + "parameters": [ + { + "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": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests to fetch attestations for.", + "minItems": 1, + "maxItems": 1024 + }, + "predicate_type": { + "type": "string", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types." + } + }, + "required": [ + "subject_digests" + ] + }, + "examples": { + "default": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "withPredicateType": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ], + "predicateType": "provenance" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The bundle of the attestation." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } } }, - { - "number": 3, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", - "html_url": "https://github.com/octocat/hello-world/code-scanning/3", - "state": "dismissed", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" + "description": "Mapping of subject digest to bundles." + }, + "page_info": { + "type": "object", + "properties": { + "has_next": { + "type": "boolean", + "description": "Indicates whether there is a next page." }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" + "has_previous": { + "type": "boolean", + "description": "Indicates whether there is a previous page." }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "lib/ab12-gen.js", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [] + "next": { + "type": "string", + "description": "The cursor to the next page." }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", - "repository": { - "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}", - "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}", - "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}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + "previous": { + "type": "string", + "description": "The cursor to the previous page." } - } - ] + }, + "description": "Information about the current page." + } + } + }, + "examples": { + "default": { + "value": { + "attestations_subject_digests": [ + { + "sha256:abc": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/attestations/delete-request": { + "post": { + "summary": "Delete attestations in bulk", + "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk" + }, + "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", + "oneOf": [ + { + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "subject_digests" + ] + }, + { + "properties": { + "attestation_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of unique IDs associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "attestation_ids" + ] + } + ], + "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + }, + "examples": { + "by-subject-digests": { + "summary": "Delete by subject digests", + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "by-attestation-ids": { + "summary": "Delete by attestation IDs", + "value": { + "attestation_ids": [ + 111, + 222 + ] + } } } } + } + }, + "responses": { + "200": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -71393,22 +69377,76 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, + "/orgs/{org}/attestations/digest/{subject_digest}": { + "delete": { + "summary": "Delete attestations by subject digest", + "description": "Delete an artifact attestation by subject digest.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-attestations-by-subject-digest", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "503": { - "description": "Service unavailable", + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "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": { - "code": { - "type": "string" - }, "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -71419,22 +69457,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-scanning", - "subcategory": "code-scanning" + "category": "orgs", + "subcategory": "attestations" } } }, - "/orgs/{org}/code-security/configurations": { - "get": { - "summary": "Get code security configurations for an organization", - "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "/orgs/{org}/attestations/{attestation_id}": { + "delete": { + "summary": "Delete attestations by ID", + "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/get-configurations-for-org", + "operationId": "orgs/delete-attestations-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization" + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id" }, "parameters": [ { @@ -71447,24 +69485,100 @@ } }, { - "name": "target_type", - "in": "query", - "description": "The target type of the code security configuration", - "required": false, + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "global", - "all" - ], - "default": "all" + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "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": "orgs", + "subcategory": "attestations" + } + } + }, + "/orgs/{org}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-attestations" + }, + "parameters": [ { "name": "per_page", - "in": "query", "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).\"", - "required": false, + "in": "query", "schema": { "type": "integer", "default": 30 @@ -71487,6 +69601,260 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/blocks": { + "get": { + "summary": "List users blocked by an organization", + "description": "List the users blocked by an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-blocked-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-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/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": { @@ -71497,346 +69865,206 @@ "schema": { "type": "array", "items": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "A code security configuration", "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] + "nullable": true, + "type": "string" }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "email": { + "nullable": true, + "type": "string" }, - "dependency_graph_autosubmit_action": { + "login": { "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "octocat" }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "dependabot_alerts": { + "node_id": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "MDQ6VXNlcjE=" }, - "dependabot_security_updates": { + "avatar_url": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "code_scanning_default_setup": { + "gravatar_id": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "code_scanning_delegated_alert_dismissal": { + "url": { "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "secret_scanning": { + "html_url": { "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://github.com/octocat" }, - "secret_scanning_push_protection": { + "followers_url": { "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "secret_scanning_delegated_bypass": { + "following_url": { "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "secret_scanning_validity_checks": { + "gists_url": { "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "secret_scanning_non_provider_patterns": { + "starred_url": { "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "secret_scanning_generic_secrets": { + "subscriptions_url": { "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "secret_scanning_delegated_alert_dismissal": { + "organizations_url": { "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "private_vulnerability_reporting": { + "repos_url": { "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "enforcement": { + "events_url": { "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "url": { + "received_events_url": { "type": "string", "format": "uri", - "description": "The URL of the configuration" + "example": "https://api.github.com/users/octocat/received_events" }, - "html_url": { + "type": { "type": "string", - "format": "uri", - "description": "The URL of the configuration" + "example": "User" }, - "created_at": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "date-time" + "example": "\"2020-07-09T00:17:55Z\"" }, - "updated_at": { + "user_view_type": { "type": "string", - "format": "date-time" + "example": "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" + ] } }, "examples": { "default": { "value": [ { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_delagated_alert_dismissal": "enabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "enabled", - "secret_scanning_delegated_bypass_options": { - "reviewers": [ - { - "security_configuration_id": 17, - "reviewer_id": 5678, - "reviewer_type": "TEAM" - } - ] - }, - "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "secret_scanning_delegated_alert_dismissal": "not_set", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - }, - { - "id": 1326, - "target_type": "organization", - "name": "High risk settings", - "description": "This is a code security configuration for octo-org high risk repositories", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "enabled", - "code_scanning_default_setup": "enabled", - "code_scanning_delagated_alert_dismissal": "enabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", - "created_at": "2024-05-10T00:00:00Z", - "updated_at": "2024-05-10T00:00:00Z" + "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 } ] } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + } + }, + "/orgs/{org}/blocks/{username}": { + "get": { + "summary": "Check if a user is blocked by an organization", + "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-blocked-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "If the user is blocked" + }, + "404": { + "description": "If the user is not blocked", "content": { "application/json": { "schema": { @@ -71860,15 +70088,62 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + }, + "put": { + "summary": "Block a user from an organization", + "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", + "tags": [ + "orgs" + ], + "operationId": "orgs/block-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "404": { - "description": "Resource not found", + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -71876,11 +70151,50 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -71891,20 +70205,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" } }, - "post": { - "summary": "Create a code security configuration", - "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "delete": { + "summary": "Unblock a user from an organization", + "description": "Unblocks the given user on behalf of the specified organization.", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/create-configuration", + "operationId": "orgs/unblock-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration" + "url": "https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization" }, "parameters": [ { @@ -71915,631 +70229,41 @@ "schema": { "type": "string" } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ], - "default": "disabled" - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "enabled" - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", - "default": false - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "code_scanning_options": { - "type": "object", - "description": "Security Configuration feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "not_set" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ], - "default": "enforced" - } - }, - "required": [ - "name", - "description" - ] - }, - "examples": { - "default": { - "summary": "Example for a code security configuration", - "value": { - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "secret_scanning": "enabled" - } - } - } - } - } - }, "responses": { - "201": { - "description": "Successfully created code security configuration", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" } } }, - "/orgs/{org}/code-security/configurations/defaults": { + "/orgs/{org}/campaigns": { "get": { - "summary": "Get default code security configurations", - "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "List campaigns for an organization", + "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/get-default-configurations", + "operationId": "campaigns/list-org-campaigns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations" + "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization" }, "parameters": [ { @@ -72550,6 +70274,69 @@ "schema": { "type": "string" } + }, + { + "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 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "state", + "description": "If specified, only campaigns with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "ends_at", + "published" + ], + "default": "created" + } } ], "responses": { @@ -72559,379 +70346,487 @@ "application/json": { "schema": { "type": "array", - "description": "A list of default code security configurations", "items": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", "properties": { - "default_for_new_repos": { - "enum": [ - "public", - "private_and_internal", - "all" - ], - "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + "number": { + "type": "integer", + "description": "The number of the newly created campaign" }, - "configuration": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "name": { + "type": "string", + "description": "The campaign name" + }, + "description": { + "type": "string", + "description": "The campaign description" + }, + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." + "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" + ] + } + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", + "nullable": true + }, + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "contact_link": { + "description": "The contact link of the campaign.", + "type": "string", + "format": "uri", + "nullable": true + }, + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" }, - "created_at": { - "type": "string", - "format": "date-time" + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" }, - "updated_at": { - "type": "string", - "format": "date-time" + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" } - } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } - } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] } }, "examples": { "default": { "value": [ { - "default_for_new_repos": "public", - "configuration": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "enabled", - "secret_scanning_delegated_bypass_options": { - "reviewers": [ - { - "security_configuration_id": 1325, - "reviewer_id": 5678, - "reviewer_type": "TEAM" - } - ] - }, - "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open" }, { - "default_for_new_repos": "private_and_internal", - "configuration": { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - } + "number": 4, + "created_at": "2024-03-30T12:29:18Z", + "updated_at": "2024-03-30T12:29:18Z", + "name": "Mitre top 10 KEV", + "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.", + "managers": [ + { + "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 + } + ], + "ends_at": "2024-04-30T12:29:18Z", + "closed_at": null, + "state": "open" } ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72956,25 +70851,20 @@ } } }, - "404": { - "description": "Resource not found", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -72986,22 +70876,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } - } - }, - "/orgs/{org}/code-security/configurations/detach": { - "delete": { - "summary": "Detach configurations from repositories", - "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + }, + "post": { + "summary": "Create a campaign for an organization", + "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/detach-configuration", + "operationId": "campaigns/create-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" + "url": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization" }, "parameters": [ { @@ -73022,25 +70910,104 @@ "type": "object", "additionalProperties": false, "properties": { - "selected_repository_ids": { + "name": { + "description": "The name of the campaign", + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "description": "A description for the campaign", + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "managers": { + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The login of each manager", + "type": "string" + } + }, + "team_managers": { + "description": "The slugs of the teams to set as the campaign managers.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The slug of each team", + "type": "string" + } + }, + "ends_at": { + "description": "The end date and time of the campaign. The date must be in the future.", + "type": "string", + "format": "date-time" + }, + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", + "type": "string", + "format": "uri", + "nullable": true + }, + "code_scanning_alerts": { + "description": "The code scanning alerts to include in this campaign", "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", "minItems": 1, - "maxItems": 1000, "items": { - "type": "integer", - "description": "Unique identifier of the repository." + "type": "object", + "additionalProperties": false, + "properties": { + "repository_id": { + "type": "integer", + "description": "The repository id" + }, + "alert_numbers": { + "type": "array", + "description": "The alert numbers", + "minItems": 1, + "items": { + "type": "integer" + } + } + }, + "required": [ + "repository_id", + "alert_numbers" + ] } + }, + "generate_issues": { + "description": "If true, will automatically generate issues for the campaign. The default is false.", + "type": "boolean", + "default": false } - } + }, + "required": [ + "name", + "description", + "ends_at", + "code_scanning_alerts" + ] }, "examples": { "default": { - "summary": "Example for detaching repositories from configurations.", "value": { - "selected_repository_ids": [ - 32, - 91 + "name": "Critical CodeQL alerts", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + "octocat" + ], + "ends_at": "2024-03-14T00:00:00Z", + "code_scanning_alerts": [ + { + "repository_id": 1296269, + "alert_numbers": [ + 1, + 2 + ] + } ] } } @@ -73049,62 +71016,445 @@ } }, "responses": { - "204": { - "description": "A header with no content is returned." - }, - "400": { - "description": "Bad Request", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", "properties": { - "message": { - "type": "string" + "number": { + "type": "integer", + "description": "The number of the newly created campaign" }, - "documentation_url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { + "name": { "type": "string", - "nullable": true + "description": "The campaign name" }, - "documentation_url": { + "description": { "type": "string", - "nullable": true + "description": "The campaign description" }, - "detail": { + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + } + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", "nullable": true }, - "status": { - "type": "integer" + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] }, - "scimType": { + "contact_link": { + "description": "The contact link of the campaign.", "type": "string", + "format": "uri", "nullable": true }, - "schemas": { - "type": "array", - "items": { - "type": "string" + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] + } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] + }, + "examples": { + "default": { + "value": { + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 } } } @@ -73112,8 +71462,8 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -73164,8 +71514,8 @@ } } }, - "409": { - "description": "Conflict", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -73189,27 +71539,51 @@ } } } + }, + "429": { + "description": "Too Many Requests" + }, + "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": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } } }, - "/orgs/{org}/code-security/configurations/{configuration_id}": { + "/orgs/{org}/campaigns/{campaign_number}": { "get": { - "summary": "Get a code security configuration", - "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "summary": "Get a campaign for an organization", + "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/get-configuration", + "operationId": "campaigns/get-campaign-summary", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration" + "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization" }, "parameters": [ { @@ -73222,8 +71596,8 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "campaign_number", + "description": "The campaign number.", "in": "path", "required": true, "schema": { @@ -73237,317 +71611,449 @@ "content": { "application/json": { "schema": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", - "description": "A code security configuration", "properties": { - "id": { + "number": { "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] + "description": "The number of the newly created campaign" }, - "dependency_graph": { + "created_at": { "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependency_graph_autosubmit_action": { + "updated_at": { "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependabot_alerts": { + "name": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The campaign name" }, - "dependabot_security_updates": { + "description": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The campaign description" }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } + "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" + ] } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, "required": [ - "reviewer_id", - "reviewer_type" - ], + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", "properties": { - "reviewer_id": { + "id": { + "description": "Unique identifier of the team", "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "example": 1 }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "secret_scanning_delegated_alert_dismissal": { + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "private_vulnerability_reporting": { + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "nullable": true }, - "enforcement": { + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", "type": "string", - "description": "The enforcement status for a security configuration", "enum": [ - "enforced", - "unenforced" + "open", + "closed" ] }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { + "contact_link": { + "description": "The contact link of the campaign.", "type": "string", "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { - "type": "string", - "format": "date-time" + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } - } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] }, "examples": { "default": { "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 + } } } } } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -73572,8 +72078,8 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -73597,25 +72103,46 @@ } } } + }, + "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": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } }, "patch": { - "summary": "Update a code security configuration", - "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "summary": "Update a campaign", + "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/update-configuration", + "operationId": "campaigns/update-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" + "url": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign" }, "parameters": [ { @@ -73628,8 +72155,8 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "campaign_number", + "description": "The campaign number.", "in": "path", "required": true, "schema": { @@ -73646,248 +72173,60 @@ "additionalProperties": false, "properties": { "name": { + "description": "The name of the campaign", "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." + "minLength": 1, + "maxLength": 50 }, "description": { + "description": "A description for the campaign", "type": "string", - "description": "A description of the code security configuration", + "minLength": 1, "maxLength": 255 }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } + "managers": { + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "type": "array", + "maxItems": 10, + "items": { + "type": "string" } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } + "team_managers": { + "description": "The slugs of the teams to set as the campaign managers.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The slug of each team", + "type": "string" } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { + "ends_at": { + "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "private_vulnerability_reporting": { + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "nullable": true }, - "enforcement": { + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", "type": "string", - "description": "The enforcement status for a security configuration", "enum": [ - "enforced", - "unenforced" + "open", + "closed" ] } } }, "examples": { "default": { - "summary": "Example for updating a code security configuration", "value": { - "name": "octo-org recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" + "name": "Critical CodeQL alerts" } } } @@ -73896,362 +72235,451 @@ }, "responses": { "200": { - "description": "Response when a configuration is updated", + "description": "Response", "content": { "application/json": { "schema": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", - "description": "A code security configuration", "properties": { - "id": { + "number": { "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The number of the newly created campaign" }, - "dependency_graph_autosubmit_action": { + "created_at": { "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependabot_alerts": { + "updated_at": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependabot_security_updates": { + "name": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } + "description": "The campaign name" }, - "code_scanning_default_setup": { + "description": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The campaign description" }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } + "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" + ] } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, "required": [ - "reviewer_id", - "reviewer_type" - ], + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", "properties": { - "reviewer_id": { + "id": { + "description": "Unique identifier of the team", "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "example": 1 }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "secret_scanning_delegated_alert_dismissal": { + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "private_vulnerability_reporting": { + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "nullable": true }, - "enforcement": { + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", "type": "string", - "description": "The enforcement status for a security configuration", "enum": [ - "enforced", - "unenforced" + "open", + "closed" ] }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { + "contact_link": { + "description": "The contact link of the campaign.", "type": "string", "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { - "type": "string", - "format": "date-time" + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } - } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] }, "examples": { "default": { "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings v2", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "disabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 + } } } } } } }, - "204": { - "description": "Response when no new updates are made" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" - } - }, - "delete": { - "summary": "Delete a code security configuration", - "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/delete-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "A header with no content is returned." - }, "400": { "description": "Bad Request", "content": { @@ -74275,45 +72703,11 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -74338,8 +72732,8 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -74364,25 +72758,20 @@ } } }, - "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": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -74394,22 +72783,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } - } - }, - "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { - "post": { - "summary": "Attach a configuration to repositories", - "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + }, + "delete": { + "summary": "Delete a campaign for an organization", + "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/attach-configuration", + "operationId": "campaigns/delete-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories" + "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization" }, "parameters": [ { @@ -74422,8 +72809,8 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "campaign_number", + "description": "The campaign number.", "in": "path", "required": true, "schema": { @@ -74431,64 +72818,52 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "scope": { - "type": "string", - "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", - "enum": [ - "all", - "all_without_configurations", - "public", - "private_or_internal", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." + "responses": { + "204": { + "description": "Deletion successful" + }, + "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": [ - "scope" - ] - }, - "examples": { - "default": { - "summary": "Example for attaching a configuration to some repositories", - "value": { - "scope": "selected", - "selected_repository_ids": [ - 32, - 91 - ] - } } } } - } - }, - "responses": { - "202": { - "description": "Accepted", + }, + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } } } } @@ -74498,22 +72873,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } } }, - "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { - "put": { - "summary": "Set a code security configuration as a default for an organization", - "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "/orgs/{org}/code-scanning/alerts": { + "get": { + "summary": "List code scanning alerts for an organization", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ - "code-security" + "code-scanning" ], - "operationId": "code-security/set-configuration-as-default", + "operationId": "code-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -74526,532 +72901,497 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_for_new_repos": { - "type": "string", - "description": "Specify which types of repository this security configuration should be applied to by default.", - "enum": [ - "all", - "none", - "private_and_internal", - "public" - ] - } - } - }, - "examples": { - "default": { - "summary": "Set this configuration to be enabled by default on all new repositories.", - "value": { - "default_for_new_repos": "all" - } - } - } + }, + { + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "query", + "required": false, + "schema": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "state", + "description": "If specified, only code scanning alerts with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "severity", + "description": "If specified, only code scanning alerts with this severity will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Severity of a code scanning alert.", + "enum": [ + "critical", + "high", + "medium", + "low", + "warning", + "note", + "error" + ] } } - }, + ], "responses": { "200": { - "description": "Default successfully changed.", + "description": "Response", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "default_for_new_repos": { - "type": "string", - "description": "Specifies which types of repository this security configuration is applied to by default.", - "enum": [ - "all", - "none", - "private_and_internal", - "public" - ] - }, - "configuration": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "type": "array", + "items": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "nullable": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "fixed_at": { + "type": "string", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "dismissed_at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "security_severity_level": { + "nullable": true, + "type": "string", + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "A description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" } + }, + "help": { + "nullable": true, + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "nullable": true, + "type": "string", + "description": "A link to the documentation for the rule used to detect the alert." } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" } - } - } - } - }, - "examples": { - "default": { - "value": { - "default_for_new_repos": "all", - "configuration": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." }, - "code_scanning_options": { - "allow_advanced": false + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "category": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "nullable": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + } + } } - } - } - } - } - } - } - }, - "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": "code-security", - "subcategory": "configurations" - } - } - }, - "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { - "get": { - "summary": "Get repositories associated with a code security configuration", - "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/get-repositories-for-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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", - "required": false, - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "status", - "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "all" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "description": "Repositories associated with a code security configuration and attachment status", - "properties": { - "status": { - "type": "string", - "description": "The attachment status of the code security configuration on the repository.", - "enum": [ - "attached", - "attaching", - "detached", - "removed", - "enforced", - "failed", - "updating", - "removed_by_enterprise" - ] }, "repository": { "title": "Simple Repository", @@ -75471,96 +73811,416 @@ "trees_url", "url" ] + }, + "dismissal_approved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true } - } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance", + "repository" + ] } }, "examples": { "default": { - "summary": "Example of code security configuration repositories", "value": [ { - "status": "attached", + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "dismissed_comment": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", "repository": { - "value": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } + "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}", + "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}", + "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}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", + "repository": { + "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}", + "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}", + "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}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" } } ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75585,25 +74245,20 @@ } } }, - "404": { - "description": "Resource not found", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -75615,47 +74270,71 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "code-scanning", + "subcategory": "code-scanning" } } }, - "/orgs/{org}/codespaces": { + "/orgs/{org}/code-security/configurations": { "get": { - "summary": "List codespaces for the organization", - "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get code security configurations for an organization", + "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-in-organization", + "operationId": "code-security/get-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization" + "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization" }, "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "target_type", + "in": "query", + "description": "The target type of the code security configuration", + "required": false, + "schema": { + "type": "string", + "enum": [ + "global", + "all" + ], + "default": "all" + } + }, { "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", + "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).\"", + "required": false, "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).\"", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, "schema": { - "type": "integer", - "default": 1 + "type": "string" } }, { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, "schema": { "type": "string" } @@ -75667,1683 +74346,1433 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "codespaces" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "codespaces": { - "type": "array", - "items": { + "type": "array", + "items": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { "type": "object", - "title": "Codespace", - "description": "A codespace.", + "description": "Feature options for Automatic dependency submission", "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "Automatically generated name of this codespace.", - "type": "string", - "example": "monalisa-octocat-hello-world-g4wpq6h95q" - }, - "display_name": { - "description": "Display name for this codespace.", + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, "type": "string", - "example": "bookish space pancake", - "nullable": true + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", + "runner_label": { + "nullable": true, "type": "string", - "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "nullable": true - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_delagated_alert_dismissal": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 17, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] + }, + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "secret_scanning_delegated_alert_dismissal": "not_set", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "organization", + "name": "High risk settings", + "description": "This is a code security configuration for octo-org high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "code_scanning_delagated_alert_dismissal": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" + } + ] + } + } + } + } + }, + "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": "code-security", + "subcategory": "configurations" + } + }, + "post": { + "summary": "Create a code security configuration", + "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/create-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration" + }, + "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", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ], + "default": "disabled" + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", + "default": false + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_options": { + "type": "object", + "description": "Security Configuration feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "not_set" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" }, - "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" - ] - }, - "billable_owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] + }, + "examples": { + "default": { + "summary": "Example for a code security configuration", + "value": { + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, "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" - ] - }, - "machine": { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", + "reviewer_id", + "reviewer_type" + ], "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "example": "standardLinux" - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "example": "4 cores, 16 GB RAM, 64 GB storage" - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "example": "linux" - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "example": 68719476736 - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "example": 17179869184 - }, - "cpus": { + "reviewer_id": { "type": "integer", - "description": "How many cores are available to the codespace.", - "example": 4 + "description": "The ID of the team or role selected as a bypass reviewer" }, - "prebuild_availability": { + "reviewer_type": { "type": "string", - "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", - "example": "ready", + "description": "The type of the bypass reviewer", "enum": [ - "none", - "ready", - "in_progress" - ], - "nullable": true + "TEAM", + "ROLE" + ] } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ], - "nullable": true + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations", + "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations" + }, + "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": "array", + "description": "A list of default code security configurations", + "items": { + "type": "object", + "properties": { + "default_for_new_repos": { + "enum": [ + "public", + "private_and_internal", + "all" + ], + "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + }, + "configuration": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", + "name": { "type": "string", - "example": ".devcontainer/example/devcontainer.json", - "nullable": true - }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": "boolean", - "example": false, - "nullable": true + "description": "The name of the code security configuration. Must be unique within the organization." }, - "created_at": { + "target_type": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "updated_at": { + "description": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "description": "A description of the code security configuration" }, - "last_used_at": { - "description": "Last known time this codespace was started.", + "advanced_security": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] }, - "state": { - "description": "State of this codespace.", + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", "enum": [ - "Unknown", - "Created", - "Queued", - "Provisioning", - "Available", - "Awaiting", - "Unavailable", - "Deleted", - "Moved", - "Shutdown", - "Archived", - "Starting", - "ShuttingDown", - "Failed", - "Exporting", - "Updating", - "Rebuilding" - ], - "example": "Available", - "type": "string" + "enabled", + "disabled", + "not_set" + ] }, - "url": { - "description": "API URL for this codespace.", + "dependency_graph_autosubmit_action": { "type": "string", - "format": "uri" + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "git_status": { - "description": "Details about the codespace's git repository.", + "dependency_graph_autosubmit_action_options": { "type": "object", + "description": "Feature options for Automatic dependency submission", "properties": { - "ahead": { - "description": "The number of commits the local repository is ahead of the remote.", - "type": "integer", - "example": 0 - }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "example": 0 - }, - "has_unpushed_changes": { - "description": "Whether the local repository has unpushed changes.", - "type": "boolean" - }, - "has_uncommitted_changes": { - "description": "Whether the local repository has uncommitted changes.", - "type": "boolean" - }, - "ref": { - "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", - "type": "string", - "example": "main" + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, - "location": { - "description": "The initally assigned location of a new codespace.", + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "example": "WestUs2", - "type": "string" - }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": "integer", - "example": 60, - "nullable": true + "enabled", + "disabled", + "not_set" + ] }, - "web_url": { - "description": "URL to access this codespace on the web.", + "dependabot_security_updates": { "type": "string", - "format": "uri" + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "machines_url": { - "description": "API URL to access available alternate machine types for this codespace.", - "type": "string", - "format": "uri" + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } }, - "start_url": { - "description": "API URL to start this codespace.", + "code_scanning_default_setup": { "type": "string", - "format": "uri" + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "stop_url": { - "description": "API URL to stop this codespace.", + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { "type": "string", - "format": "uri" + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "publish_url": { - "description": "API URL to publish this codespace to a new repository.", + "secret_scanning": { "type": "string", - "format": "uri", - "nullable": true + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", + "secret_scanning_push_protection": { "type": "string", - "format": "uri", - "nullable": true + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "recent_folders": { - "type": "array", - "items": { - "type": "string" - } + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "runtime_constraints": { + "secret_scanning_delegated_bypass_options": { "type": "object", + "description": "Feature options for secret scanning delegated bypass", "properties": { - "allowed_port_privacy_settings": { - "description": "The privacy settings a user can select from when forwarding a port.", + "reviewers": { "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", "items": { - "type": "string" - }, - "nullable": true + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } } } }, - "pending_operation": { - "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", - "type": "boolean", - "nullable": true + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", + "secret_scanning_non_provider_patterns": { "type": "string", - "nullable": true + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "secret_scanning_generic_secrets": { "type": "string", - "nullable": true + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "retention_period_minutes": { - "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", - "type": "integer", - "example": 60, - "nullable": true + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "private_vulnerability_reporting": { "type": "string", - "format": "date-time", - "example": "2011-01-26T20:01:12Z", - "nullable": true + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "last_known_stop_notice": { - "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "enforcement": { "type": "string", - "example": "you've used 100% of your spending limit for Codespaces", - "nullable": true + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } - }, - "required": [ - "id", - "name", - "environment_id", - "owner", - "billable_owner", - "repository", - "machine", - "prebuild", - "created_at", - "updated_at", - "last_used_at", - "state", - "url", - "git_status", - "location", - "idle_timeout_minutes", - "web_url", - "machines_url", - "start_url", - "stop_url", - "pulls_url", - "recent_folders" - ] + } } } } }, "examples": { "default": { - "value": { - "total_count": 3, - "codespaces": [ - { - "id": 1, - "name": "monalisa-octocat-hello-world-g4wpq6h95q", - "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "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 - }, - "billable_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 - }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", - "recent_folders": [] - }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-3f89ada1j3", - "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", - "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 + "value": [ + { + "default_for_new_repos": "public", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false }, - "billable_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 + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "code_scanning_options": { + "allow_advanced": false }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 1325, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] }, - "prebuild": false, - "devcontainer_path": ".devcontainer/foobar/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + { + "default_for_new_repos": "private_and_internal", + "configuration": { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", - "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": [] - }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", - "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 + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null }, - "billable_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 + "code_scanning_options": { + "allow_advanced": false }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", - "recent_folders": [] + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" } - ] - } + } + ] } } } @@ -77352,58 +75781,6 @@ "304": { "description": "Not modified" }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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": { @@ -77459,23 +75836,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/codespaces/access": { - "put": { - "summary": "Manage access control for organization codespaces", - "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/code-security/configurations/detach": { + "delete": { + "summary": "Detach configurations from repositories", + "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/set-codespaces-access", + "operationId": "code-security/detach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces" + "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" }, "parameters": [ { @@ -77488,44 +75865,33 @@ } } ], - "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", + "additionalProperties": false, "properties": { - "visibility": { - "type": "string", - "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.", - "enum": [ - "disabled", - "selected_members", - "all_members", - "all_members_and_outside_collaborators" - ] - }, - "selected_usernames": { + "selected_repository_ids": { "type": "array", - "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.", + "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "minItems": 1, + "maxItems": 1000, "items": { - "type": "string" - }, - "maxItems": 100 + "type": "integer", + "description": "Unique identifier of the repository." + } } - }, - "required": [ - "visibility" - ] + } }, "examples": { "default": { + "summary": "Example for detaching repositories from configurations.", "value": { - "visibility": "selected_members", - "selected_usernames": [ - "johnDoe", - "atomIO" + "selected_repository_ids": [ + 32, + 91 ] } } @@ -77535,16 +75901,10 @@ }, "responses": { "204": { - "description": "Response when successfully modifying permissions." - }, - "304": { - "description": "Not modified" + "description": "A header with no content is returned." }, "400": { - "description": "Users are neither members nor collaborators of this organization." - }, - "404": { - "description": "Resource not found", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -77566,71 +75926,36 @@ } } } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Scim Error", + "description": "Scim Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { - "type": "string" + "type": "string", + "nullable": true }, "documentation_url": { - "type": "string" + "type": "string", + "nullable": true }, - "errors": { + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + "type": "string" } } } @@ -77638,8 +75963,8 @@ } } }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -77663,82 +75988,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" - } - } - }, - "/orgs/{org}/codespaces/access/selected_users": { - "post": { - "summary": "Add users to Codespaces access for an organization", - "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/set-codespaces-access-users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "deprecated": true, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members whose codespaces be billed to the organization.", - "items": { - "type": "string" - }, - "maxItems": 100 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "johnDoe", - "atomIO" - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response when successfully modifying permissions." - }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", @@ -77766,77 +76015,8 @@ } } }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -77864,23 +76044,24 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - }, - "delete": { - "summary": "Remove users from Codespaces access for an organization", - "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}": { + "get": { + "summary": "Get a code security configuration", + "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/delete-codespaces-access-users", + "operationId": "code-security/get-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" + "url": "https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration" }, - "deprecated": true, "parameters": [ { "name": "org", @@ -77890,53 +76071,334 @@ "schema": { "type": "string" } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members whose codespaces should not be billed to the organization.", - "items": { - "type": "string" + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" }, - "maxItems": 100 + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } } }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "johnDoe", - "atomIO" - ] + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } } } } } - } - }, - "responses": { - "204": { - "description": "Response when successfully modifying permissions." }, "304": { "description": "Not modified" }, - "400": { - "description": "Users are neither members nor collaborators of this organization." - }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -77961,77 +76423,8 @@ } } }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78059,23 +76452,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - } - }, - "/orgs/{org}/codespaces/secrets": { - "get": { - "summary": "List organization secrets", - "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-org-secrets", + "operationId": "code-security/update-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets" + "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" }, "parameters": [ { @@ -78088,224 +76479,605 @@ } }, { - "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", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Codespaces Secret", - "description": "Secrets for a GitHub Codespace.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret", - "example": "SECRET_NAME", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "secrets": [ - { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z", - "visibility": "all" + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } } - ] + } } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] } } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - } - }, - "/orgs/{org}/codespaces/secrets/public-key": { - "get": { - "summary": "Get an organization public key", - "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key" - }, - "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": "Response when a configuration is updated", "content": { "application/json": { "schema": { - "title": "CodespacesPublicKey", - "description": "The public key used for setting Codespaces secrets.", "type": "object", + "description": "A code security configuration", "properties": { - "key_id": { - "description": "The identifier for the key.", + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { "type": "string", - "example": "1234567" + "description": "The name of the code security configuration. Must be unique within the organization." }, - "key": { - "description": "The Base64 encoded public key.", + "target_type": { "type": "string", - "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "id": { - "type": "integer", - "example": 2 + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] }, "url": { "type": "string", - "example": "https://api.github.com/user/keys/2" + "format": "uri", + "description": "The URL of the configuration" }, - "title": { + "html_url": { "type": "string", - "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + "format": "uri", + "description": "The URL of the configuration" }, "created_at": { "type": "string", - "example": "2011-01-26T19:01:12Z" + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } - }, - "required": [ - "key_id", - "key" - ] + } }, "examples": { "default": { "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings v2", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "disabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" } } } } } + }, + "204": { + "description": "Response when no new updates are made" } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - } - }, - "/orgs/{org}/codespaces/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "delete": { + "summary": "Delete a code security configuration", + "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/get-org-secret", + "operationId": "code-security/delete-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret" + "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration" }, "parameters": [ { @@ -78318,199 +77090,105 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "A header with no content is returned." + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "title": "Codespaces Secret", - "description": "Secrets for a GitHub Codespace.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "name": { - "description": "The name of the secret", - "example": "SECRET_NAME", + "message": { "type": "string" }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" + "documentation_url": { + "type": "string" }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", - "enum": [ - "all", - "private", - "selected" - ], + "url": { "type": "string" }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + "status": { + "type": "string" } } } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + }, + "application/scim+json": { "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - }, - "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/create-or-update-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "The ID of the key you used to encrypt the secret." - }, - "visibility": { - "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } } - }, - "required": [ - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } } } } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", + }, + "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" + } } } } } }, - "204": { - "description": "Response when updating a secret" - }, "404": { "description": "Resource not found", "content": { @@ -78537,18 +77215,14 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -78556,50 +77230,11 @@ "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -78609,21 +77244,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach a configuration to repositories", + "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/delete-org-secret", + "operationId": "code-security/attach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret" + "url": "https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories" }, "parameters": [ { @@ -78636,40 +77273,73 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "scope": { + "type": "string", + "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", + "enum": [ + "all", + "all_without_configurations", + "public", + "private_or_internal", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "scope" + ] + }, + "examples": { + "default": { + "summary": "Example for attaching a configuration to some repositories", + "value": { + "scope": "selected", + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", + "202": { + "description": "Accepted", "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" - } + "type": "object" + }, + "examples": { + "default": { + "value": null } } } @@ -78678,23 +77348,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { - "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an organization", + "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-selected-repos-for-org-secret", + "operationId": "code-security/set-configuration-as-default", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" }, "parameters": [ { @@ -78707,71 +77377,558 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 + "type": "integer" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + }, + "configuration": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + } + } + }, + "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": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + "get": { + "summary": "Get repositories associated with a code security configuration", + "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-repositories-for-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "Repositories associated with a code security configuration and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { "type": "integer", "format": "int64", - "example": 1296269 + "example": 1296269, + "description": "A unique identifier of the repository." }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", - "example": "Hello-World" + "example": "Hello-World", + "description": "The name of the repository." }, "full_name": { "type": "string", - "example": "octocat/Hello-World" + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", @@ -78898,488 +78055,223 @@ ] }, "private": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true + "nullable": true, + "description": "The repository description." }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." } }, "required": [ @@ -79436,719 +78328,83 @@ }, "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] - } - } - } - } - } - }, - "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": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - }, - "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/set-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "integer" - } - } - }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "409": { - "description": "Conflict when visibility type not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - } - }, - "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/add-selected-repo-to-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "No Content when repository was added to the selected list" - }, - "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 when visibility type is not set to selected" - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - }, - "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/remove-selected-repo-from-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response when repository was removed from the selected list" - }, - "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 when visibility type not set to selected" - }, - "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" - }, + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } } } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - } - }, - "/orgs/{org}/copilot/billing": { - "get": { - "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/get-copilot-organization-details", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-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": "OK", - "content": { - "application/json": { - "schema": { - "title": "Copilot Organization Details", - "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", - "type": "object", - "properties": { - "seat_breakdown": { - "title": "Copilot Seat Breakdown", - "description": "The breakdown of Copilot Business seats for the organization.", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "The total number of seats being billed for the organization as of the current billing cycle." - }, - "added_this_cycle": { - "type": "integer", - "description": "Seats added during the current billing cycle." - }, - "pending_cancellation": { - "type": "integer", - "description": "The number of seats that are pending cancellation at the end of the current billing cycle." - }, - "pending_invitation": { - "type": "integer", - "description": "The number of users who have been invited to receive a Copilot seat through this organization." - }, - "active_this_cycle": { - "type": "integer", - "description": "The number of seats that have used Copilot during the current billing cycle." - }, - "inactive_this_cycle": { - "type": "integer", - "description": "The number of seats that have not used Copilot during the current billing cycle." - } - } - }, - "public_code_suggestions": { - "type": "string", - "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", - "enum": [ - "allow", - "block", - "unconfigured" - ] - }, - "ide_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "platform_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "cli": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "seat_management_setting": { - "type": "string", - "description": "The mode of assigning new seats.", - "enum": [ - "assign_all", - "assign_selected", - "disabled", - "unconfigured" - ] - }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise" - ] - } - }, - "required": [ - "seat_breakdown", - "public_code_suggestions", - "seat_management_setting" - ], - "additionalProperties": true - }, - "examples": { - "default": { - "value": { - "seat_breakdown": { - "total": 12, - "added_this_cycle": 9, - "pending_invitation": 0, - "pending_cancellation": 0, - "active_this_cycle": 12, - "inactive_this_cycle": 11 - }, - "seat_management_setting": "assign_selected", - "ide_chat": "enabled", - "platform_chat": "enabled", - "cli": "enabled", - "public_code_suggestions": "block", - "plan_type": "business" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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" - } + ] } } } @@ -80205,39 +78461,36 @@ } } } - }, - "422": { - "description": "There is a problem with your account's associated payment method." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/copilot/billing/seats": { + "/orgs/{org}/codespaces": { "get": { - "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "summary": "List codespaces for the organization", + "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/list-copilot-seats", + "operationId": "codespaces/list-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "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": "string" + "type": "integer", + "default": 30 } }, { @@ -80250,12 +78503,12 @@ } }, { - "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", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 50 + "type": "string" } } ], @@ -80266,19 +78519,44 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "codespaces" + ], "properties": { - "total_seats": { - "type": "integer", - "description": "Total number of Copilot seats for the organization currently being billed." + "total_count": { + "type": "integer" }, - "seats": { + "codespaces": { "type": "array", "items": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", + "title": "Codespace", + "description": "A codespace.", "properties": { - "assignee": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "example": "monalisa-octocat-hello-world-g4wpq6h95q" + }, + "display_name": { + "description": "Display name for this codespace.", + "type": "string", + "example": "bookish space pancake", + "nullable": true + }, + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": "string", + "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "nullable": true + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -80400,371 +78678,1083 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, "login": { "type": "string", - "example": "github" + "example": "octocat" }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/orgs/github" + "example": "https://api.github.com/users/octocat" }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/orgs/github/repos" + "example": "https://github.com/octocat" }, - "events_url": { + "followers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/orgs/github/events" + "example": "https://api.github.com/users/octocat/followers" }, - "hooks_url": { + "following_url": { "type": "string", - "example": "https://api.github.com/orgs/github/hooks" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "issues_url": { + "gists_url": { "type": "string", - "example": "https://api.github.com/orgs/github/issues" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "members_url": { + "starred_url": { "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "public_members_url": { + "subscriptions_url": { "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "avatar_url": { + "organizations_url": { "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "description": { + "repos_url": { "type": "string", - "example": "A great organization", - "nullable": true + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ - "login", - "url", + "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", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ], - "nullable": true + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, "name": { + "nullable": true, "type": "string" }, - "slug": { + "email": { + "nullable": true, "type": "string" }, - "description": { + "login": { "type": "string", - "nullable": true + "example": "octocat" }, - "privacy": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "notification_setting": { - "type": "string" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "permission": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" + "example": "https://github.com/octocat" }, - "repositories_url": { + "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" + "admin": { + "type": "boolean" }, - "description": { - "type": "string" + "maintain": { + "type": "boolean" }, - "slug": { - "type": "string" + "push": { + "type": "boolean" }, - "url": { - "type": "string", - "format": "uri" + "triage": { + "type": "boolean" }, - "sync_to_organizations": { + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "example": "disabled | all" + "example": "contributor_covenant" }, - "organization_selection_type": { + "name": { "type": "string", - "example": "disabled | all" + "example": "Contributor Covenant" }, - "group_id": { - "nullable": true, + "url": { "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, - "group_name": { - "nullable": true, + "body": { "type": "string", - "example": "Justice League" + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/enterprises/dc/teams/justice-league" - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "nullable": true } }, "required": [ - "id", "url", - "members_url", - "name", "html_url", - "slug", - "created_at", - "updated_at" + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "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" + ] + }, + "machine": { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "example": "standardLinux" + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "example": "4 cores, 16 GB RAM, 64 GB storage" + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "example": "linux" + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "example": 68719476736 + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "example": 17179869184 + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "example": 4 + }, + "prebuild_availability": { + "type": "string", + "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", + "example": "ready", + "enum": [ + "none", + "ready", + "in_progress" + ], + "nullable": true } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" ], "nullable": true }, - "pending_cancellation_date": { + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": "string", - "format": "date", - "nullable": true, - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + "example": ".devcontainer/example/devcontainer.json", + "nullable": true }, - "last_activity_at": { + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": "boolean", + "example": false, + "nullable": true + }, + "created_at": { "type": "string", "format": "date-time", - "nullable": true, - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + "example": "2011-01-26T19:01:12Z" }, - "last_activity_editor": { + "updated_at": { "type": "string", - "nullable": true, - "description": "Last editor that was used by the user for a GitHub Copilot completion." + "format": "date-time", + "example": "2011-01-26T19:01:12Z" }, - "created_at": { + "last_used_at": { + "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + "example": "2011-01-26T19:01:12Z" }, - "updated_at": { + "state": { + "description": "State of this codespace.", + "enum": [ + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "example": "Available", + "type": "string" + }, + "url": { + "description": "API URL for this codespace.", + "type": "string", + "format": "uri" + }, + "git_status": { + "description": "Details about the codespace's git repository.", + "type": "object", + "properties": { + "ahead": { + "description": "The number of commits the local repository is ahead of the remote.", + "type": "integer", + "example": 0 + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "example": 0 + }, + "has_unpushed_changes": { + "description": "Whether the local repository has unpushed changes.", + "type": "boolean" + }, + "has_uncommitted_changes": { + "description": "Whether the local repository has uncommitted changes.", + "type": "boolean" + }, + "ref": { + "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", + "type": "string", + "example": "main" + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "example": "WestUs2", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": "integer", + "example": 60, + "nullable": true + }, + "web_url": { + "description": "URL to access this codespace on the web.", + "type": "string", + "format": "uri" + }, + "machines_url": { + "description": "API URL to access available alternate machine types for this codespace.", + "type": "string", + "format": "uri" + }, + "start_url": { + "description": "API URL to start this codespace.", + "type": "string", + "format": "uri" + }, + "stop_url": { + "description": "API URL to stop this codespace.", + "type": "string", + "format": "uri" + }, + "publish_url": { + "description": "API URL to publish this codespace to a new repository.", + "type": "string", + "format": "uri", + "nullable": true + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": "string", + "format": "uri", + "nullable": true + }, + "recent_folders": { + "type": "array", + "items": { + "type": "string" + } + }, + "runtime_constraints": { + "type": "object", + "properties": { + "allowed_port_privacy_settings": { + "description": "The privacy settings a user can select from when forwarding a port.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + }, + "pending_operation": { + "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", + "type": "boolean", + "nullable": true + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": "string", + "nullable": true + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": "string", + "nullable": true + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer", + "example": 60, + "nullable": true + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": "string", "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "example": "2011-01-26T20:01:12Z", + "nullable": true }, - "plan_type": { + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" - ] + "example": "you've used 100% of your spending limit for Codespaces", + "nullable": true } }, "required": [ - "created_at" - ], - "additionalProperties": false + "id", + "name", + "environment_id", + "owner", + "billable_owner", + "repository", + "machine", + "prebuild", + "created_at", + "updated_at", + "last_used_at", + "state", + "url", + "git_status", + "location", + "idle_timeout_minutes", + "web_url", + "machines_url", + "start_url", + "stop_url", + "pulls_url", + "recent_folders" + ] } } } @@ -80772,16 +79762,13 @@ "examples": { "default": { "value": { - "total_seats": 2, - "seats": [ + "total_count": 3, + "codespaces": [ { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "plan_type": "business", - "assignee": { + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -80801,64 +79788,421 @@ "type": "User", "site_admin": false }, - "assigning_team": { + "billable_owner": { + "login": "octocat", "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } + "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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] }, { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "assignee": { - "login": "octokitten", + "id": 1, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "owner": { + "login": "octocat", "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", + "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 - } + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/foobar/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "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": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-f8adfad99a", + "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", + "recent_folders": [] } ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } }, + "304": { + "description": "Not modified" + }, "500": { "description": "Internal Error", "content": { @@ -80966,23 +80310,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" } } }, - "/orgs/{org}/copilot/billing/selected_teams": { - "post": { - "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "/orgs/{org}/codespaces/access": { + "put": { + "summary": "Manage access control for organization codespaces", + "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/add-copilot-seats-for-teams", + "operationId": "codespaces/set-codespaces-access", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces" }, "parameters": [ { @@ -80995,95 +80339,63 @@ } } ], + "deprecated": true, "requestBody": { + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "selected_teams": { + "visibility": { + "type": "string", + "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.", + "enum": [ + "disabled", + "selected_members", + "all_members", + "all_members_and_outside_collaborators" + ] + }, + "selected_usernames": { "type": "array", - "description": "List of team names within the organization to which to grant access to GitHub Copilot.", + "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.", "items": { "type": "string" }, - "minItems": 1 + "maxItems": 100 } }, "required": [ - "selected_teams" + "visibility" ] }, "examples": { "default": { "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" + "visibility": "selected_members", + "selected_usernames": [ + "johnDoe", + "atomIO" ] } } } } - }, - "required": true + } }, "responses": { - "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for members of the specified team(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } + "204": { + "description": "Response when successfully modifying permissions." }, - "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" - } - } - } - } - } + "304": { + "description": "Not modified" }, - "401": { - "description": "Requires authentication", + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81108,14 +80420,18 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -81123,19 +80439,58 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -81159,28 +80514,27 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" } - }, - "delete": { - "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + } + }, + "/orgs/{org}/codespaces/access/selected_users": { + "post": { + "summary": "Add users to Codespaces access for an organization", + "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", + "operationId": "codespaces/set-codespaces-access-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" }, "parameters": [ { @@ -81193,95 +80547,52 @@ } } ], + "deprecated": true, "requestBody": { + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "selected_teams": { + "selected_usernames": { "type": "array", - "description": "The names of teams from which to revoke access to GitHub Copilot.", + "description": "The usernames of the organization members whose codespaces be billed to the organization.", "items": { "type": "string" }, - "minItems": 1 + "maxItems": 100 } }, "required": [ - "selected_teams" + "selected_usernames" ] }, "examples": { "default": { "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" + "selected_usernames": [ + "johnDoe", + "atomIO" ] } } } } - }, - "required": true + } }, "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", - "properties": { - "seats_cancelled": { - "type": "integer" - } - }, - "required": [ - "seats_cancelled" - ] - }, - "examples": { - "default": { - "value": { - "seats_cancelled": 5 - } - } - } - } - } + "204": { + "description": "Response when successfully modifying permissions." }, - "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" - } - } - } - } - } + "304": { + "description": "Not modified" }, - "401": { - "description": "Requires authentication", + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81306,14 +80617,18 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -81321,19 +80636,58 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -81357,31 +80711,27 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" } - } - }, - "/orgs/{org}/copilot/billing/selected_users": { - "post": { - "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + }, + "delete": { + "summary": "Remove users from Codespaces access for an organization", + "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/add-copilot-seats-for-users", + "operationId": "codespaces/delete-codespaces-access-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" }, + "deprecated": true, "parameters": [ { "name": "org", @@ -81394,6 +80744,7 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { @@ -81401,11 +80752,11 @@ "properties": { "selected_usernames": { "type": "array", - "description": "The usernames of the organization members to be granted access to GitHub Copilot.", + "description": "The usernames of the organization members whose codespaces should not be billed to the organization.", "items": { "type": "string" }, - "minItems": 1 + "maxItems": 100 } }, "required": [ @@ -81416,72 +80767,27 @@ "default": { "value": { "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" + "johnDoe", + "atomIO" ] } } } } - }, - "required": true + } }, "responses": { - "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for the specified user(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } + "204": { + "description": "Response when successfully modifying permissions." }, - "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" - } - } - } - } - } + "304": { + "description": "Not modified" }, - "401": { - "description": "Requires authentication", + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81506,14 +80812,18 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -81521,19 +80831,58 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -81557,28 +80906,27 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" } - }, - "delete": { - "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + } + }, + "/orgs/{org}/codespaces/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-users", + "operationId": "codespaces/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets" }, "parameters": [ { @@ -81589,196 +80937,334 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" - ] - } - } - } + }, + { + "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 } }, - "required": true - }, + { + "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": "OK", + "description": "Response", "content": { "application/json": { "schema": { "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for the specified users.", + "required": [ + "total_count", + "secrets" + ], "properties": { - "seats_cancelled": { + "total_count": { "type": "integer" - } - }, - "required": [ - "seats_cancelled" - ] + }, + "secrets": { + "type": "array", + "items": { + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret", + "example": "SECRET_NAME", + "type": "string" + }, + "created_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "The type of repositories in the organization that the secret is visible to", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } + } + } }, "examples": { "default": { "value": { - "seats_cancelled": 5 + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z", + "visibility": "all" + } + ] } } } } - } - }, - "500": { - "description": "Internal Error", - "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" } } } - }, - "401": { - "description": "Requires authentication", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key" + }, + "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", + "title": "CodespacesPublicKey", + "description": "The public key used for setting Codespaces secrets.", "type": "object", "properties": { - "message": { - "type": "string" + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" }, - "documentation_url": { - "type": "string" + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 }, "url": { - "type": "string" + "type": "string", + "example": "https://api.github.com/user/keys/2" }, - "status": { - "type": "string" + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the secret", + "example": "SECRET_NAME", "type": "string" }, - "documentation_url": { - "type": "string" + "created_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" }, - "url": { - "type": "string" + "updated_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" }, - "status": { + "visibility": { + "description": "The type of repositories in the organization that the secret is visible to", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" } } } } - } - }, - "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" } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } - } - }, - "/orgs/{org}/copilot/metrics": { - "get": { - "summary": "Get Copilot metrics for an organization", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/copilot-metrics-for-organization", + "operationId": "codespaces/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -81791,538 +81277,93 @@ } }, { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "query", - "required": false, + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, "schema": { "type": "string" } - }, - { - "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 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). 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": 28 - } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "type": "object", - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": "string", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": "string", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in GitHub.com", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": "string", - "description": "The training date for the custom model (if applicable).", - "nullable": true - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": "object", - "description": "Usage metrics for Copilot for pull requests.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": "string", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "The ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } } }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 ] } } } } - }, - "500": { - "description": "Internal Error", + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null } } } } }, - "403": { - "description": "Forbidden", + "204": { + "description": "Response when updating a secret" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82347,14 +81388,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -82362,19 +81407,101 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "422": { - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82402,23 +81529,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/dependabot/alerts": { + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { "get": { - "summary": "List Dependabot alerts for an organization", - "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "codespaces" ], - "operationId": "dependabot/list-alerts-for-org", + "operationId": "codespaces/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -82431,145 +81558,21 @@ } }, { - "name": "state", - "in": "query", - "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", - "schema": { - "type": "string" - } - }, - { - "name": "severity", - "in": "query", - "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", - "schema": { - "type": "string" - } - }, - { - "name": "ecosystem", - "in": "query", - "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", - "schema": { - "type": "string" - } - }, - { - "name": "package", - "in": "query", - "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentage", - "in": "query", - "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "has", - "in": "query", - "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "patch" - ] - } - } - ] - } - }, - { - "name": "scope", - "in": "query", - "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", - "schema": { - "type": "string", - "enum": [ - "development", - "runtime" - ] - } - }, - { - "name": "sort", - "in": "query", - "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "epss_percentage" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", + "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", - "required": false, "schema": { "type": "integer", - "minimum": 1, - "maximum": 100 + "default": 1 } }, { @@ -82588,688 +81591,38 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": "string", - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "nullable": true, - "enum": [ - "development", - "runtime" - ] - }, - "relationship": { - "type": "string", - "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", - "readOnly": true, - "nullable": true, - "enum": [ - "unknown", - "direct", - "transitive" - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": "string", - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true, - "nullable": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": "object", - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "nullable": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": "string", - "description": "The full CVSS vector string for the advisory.", - "readOnly": true, - "nullable": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": "object", - "nullable": true, - "properties": { - "cvss_v3": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 3 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 4 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "epss": { - "type": "object", - "nullable": true, - "readOnly": true, - "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", - "properties": { - "percentage": { - "type": "number", - "minimum": 0, - "maximum": 100 - }, - "percentile": { - "type": "number", - "minimum": 0, - "maximum": 100 - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": "string", - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": "object", - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "nullable": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": "string", - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "dismissed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "dismissed_reason": { - "type": "string", - "description": "The reason that the alert was dismissed.", - "nullable": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk" - ] - }, - "dismissed_comment": { - "type": "string", - "description": "An optional comment associated with the alert's dismissal.", - "nullable": true, - "maxLength": 280 - }, - "fixed_at": { - "type": "string", - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "auto_dismissed_at": { - "type": "string", - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", - "example": "Hello-World", - "description": "The name of the repository." + "example": "Hello-World" }, "full_name": { "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." + "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", @@ -83396,1722 +81749,190 @@ ] }, "private": { - "type": "boolean", - "description": "Whether the repository is private." + "type": "boolean" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." + "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true, - "description": "The repository description." + "nullable": true }, "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." + "type": "boolean" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." + "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" }, "issue_comment_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "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": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at", - "repository" - ], - "additionalProperties": false - } - }, - "examples": { - "default": { - "value": [ - { - "number": 2, - "state": "dismissed", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "cve_id": "CVE-2018-6188", - "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { - "identifier": "1.11.10" - } - } - ], - "severity": "high", - "cvss": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", - "score": 8.7 - } - }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], - "cwes": [ - { - "cwe_id": "CWE-200", - "name": "Exposure of Sensitive Information to an Unauthorized Actor" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-rf4j-j272-fj86" - }, - { - "type": "CVE", - "value": "CVE-2018-6188" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" - }, - { - "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" - }, - { - "url": "https://usn.ubuntu.com/3559-1/" - }, - { - "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" - }, - { - "url": "http://www.securitytracker.com/id/1040422" - } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2022-04-26T18:35:37Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", - "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", - "created_at": "2022-06-15T07:43:03Z", - "updated_at": "2022-08-23T14:29:47Z", - "dismissed_at": "2022-08-23T14:29:47Z", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer.", - "fixed_at": null, - "repository": { - "id": 217723378, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "private": true, - "html_url": "https://github.com/octo-org/octo-repo", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" - } - }, - { - "number": 1, - "state": "open", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { - "identifier": "2.9.18" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { - "identifier": "2.10.7" - } - } - ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 8.5 - } - }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-8f4m-hccc-8qph" - }, - { - "type": "CVE", - "value": "CVE-2021-20191" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" - }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" - }, - { - "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" - } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-14T15:21:52Z", - "dismissed_at": null, - "dismissed_by": null, - "dismissed_reason": null, - "dismissed_comment": null, - "fixed_at": null, - "repository": { - "id": 664700648, - "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", - "name": "hello-world", - "full_name": "octo-org/hello-world", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "private": true, - "html_url": "https://github.com/octo-org/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/hello-world", - "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", - "events_url": "https://api.github.com/repos/octo-org/hello-world/events", - "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", - "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", - "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", - "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", - "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", - "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" - } - } - ] - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Bad Request", - "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "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" - } - } - } - } - } - }, - "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 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" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "alerts" - } - } - }, - "/orgs/{org}/dependabot/secrets": { - "get": { - "summary": "List organization secrets", - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/list-org-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" - }, - "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/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": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 3, - "secrets": [ - { - "name": "MY_ARTIFACTORY_PASSWORD", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "NPM_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GH_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/public-key": { - "get": { - "summary": "Get an organization public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" - }, - "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": "DependabotPublicKey", - "description": "The public key used for setting Dependabot Secrets.", - "type": "object", - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "example": "1234567" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - } - }, - "required": [ - "key_id", - "key" - ] - }, - "examples": { - "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/get-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "NPM_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - }, - "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/create-or-update-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - }, - "visibility": { - "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "string" - } - } - }, - "required": [ - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - "1296269", - "1296280" - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { - "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/list-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true }, "hooks_url": { "type": "string", @@ -85544,25 +82365,51 @@ } } } + }, + "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": "secrets" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "codespaces" ], - "operationId": "dependabot/set-selected-repos-for-org-secret", + "operationId": "codespaces/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -85593,7 +82440,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -85618,27 +82465,56 @@ "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" + } + } + } + } + } + }, + "409": { + "description": "Conflict when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "codespaces" ], - "operationId": "dependabot/add-selected-repo-to-org-secret", + "operationId": "codespaces/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -85672,27 +82548,122 @@ "204": { "description": "No Content when repository was added to the selected list" }, + "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 when visibility type is not set to selected" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "codespaces" ], - "operationId": "dependabot/remove-selected-repo-from-org-secret", + "operationId": "codespaces/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -85726,29 +82697,124 @@ "204": { "description": "Response when repository was removed from the selected list" }, + "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 when visibility type not set to selected" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/docker/conflicts": { + "/orgs/{org}/copilot/billing": { "get": { - "summary": "Get list of conflicting packages during Docker migration for organization", - "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "summary": "Get Copilot seat information and settings for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ - "packages" + "copilot" ], - "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "operationId": "copilot/get-copilot-organization-details", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" }, "parameters": [ { @@ -85763,207 +82829,307 @@ ], "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the package.", - "type": "string", - "example": "super-linter" - }, - "package_type": { - "type": "string", - "example": "docker", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string", - "example": "https://api.github.com/orgs/github/packages/container/super-linter" - }, - "html_url": { - "type": "string", - "example": "https://github.com/orgs/github/packages/container/package/super-linter" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer", - "example": 1 - }, - "visibility": { - "type": "string", - "example": "private", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", + "type": "object", + "properties": { + "seat_breakdown": { + "title": "Copilot Seat Breakdown", + "description": "The breakdown of Copilot Business seats for the organization.", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of seats being billed for the organization as of the current billing cycle." }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "added_this_cycle": { + "type": "integer", + "description": "Seats added during the current billing cycle." + }, + "pending_cancellation": { + "type": "integer", + "description": "The number of seats that are pending cancellation at the end of the current billing cycle." + }, + "pending_invitation": { + "type": "integer", + "description": "The number of users who have been invited to receive a Copilot seat through this organization." + }, + "active_this_cycle": { + "type": "integer", + "description": "The number of seats that have used Copilot during the current billing cycle." + }, + "inactive_this_cycle": { + "type": "integer", + "description": "The number of seats that have not used Copilot during the current billing cycle." + } + } + }, + "public_code_suggestions": { + "type": "string", + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" + ] + }, + "ide_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "platform_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "cli": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "seat_management_setting": { + "type": "string", + "description": "The mode of assigning new seats.", + "enum": [ + "assign_all", + "assign_selected", + "disabled", + "unconfigured" + ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise" + ] + } + }, + "required": [ + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true + }, + "examples": { + "default": { + "value": { + "seat_breakdown": { + "total": 12, + "added_this_cycle": 9, + "pending_invitation": 0, + "pending_cancellation": 0, + "active_this_cycle": 12, + "inactive_this_cycle": 11 }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { + "seat_management_setting": "assign_selected", + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "There is a problem with your account's associated payment method." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/seats": { + "get": { + "summary": "List all Copilot seat assignments for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/list-copilot-seats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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": 50 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_seats": { + "type": "integer", + "description": "Total number of Copilot seats for the organization currently being billed." + }, + "seats": { + "type": "array", + "items": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "type": "object", + "properties": { + "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -86085,3680 +83251,2025 @@ "subscriptions_url", "type", "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", + ], "nullable": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "key": { + "login": { "type": "string", - "example": "contributor_covenant" + "example": "github" }, - "name": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { "type": "string", - "example": "Contributor Covenant" + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + "example": "https://api.github.com/orgs/github" }, - "html_url": { + "repos_url": { "type": "string", "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" - } - ] - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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": false, - "category": "packages", - "subcategory": "packages" - } - } - }, - "/orgs/{org}/events": { - "get": { - "summary": "List public organization events", - "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", - "tags": [ - "activity" - ], - "operationId": "activity/list-public-org-events", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" - }, - "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/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": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string", - "nullable": true - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "name", - "url" - ] - }, - "org": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" + "example": "https://api.github.com/orgs/github/repos" }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", + "events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "repository_url": { + "hooks_url": { "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" + "example": "https://api.github.com/orgs/github/hooks" }, - "comments_url": { + "issues_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/orgs/github/issues" }, - "events_url": { + "members_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/orgs/github/members{/member}" }, - "html_url": { + "public_members_url": { "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", + "avatar_url": { "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] - }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" + "example": "https://github.com/images/error/octocat_happy.gif" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "description": { "type": "string", + "example": "A great organization", "nullable": true - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ], + "nullable": true + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { - "type": "integer", - "format": "int64", - "example": 1 + "type": "integer" }, "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "type": "string" }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { "name": { - "nullable": true, "type": "string" }, - "email": { - "nullable": true, + "slug": { "type": "string" }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" + "privacy": { + "type": "string" }, - "site_admin": { - "type": "boolean" + "notification_setting": { + "type": "string" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "permission": { + "type": "string" }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } }, - "user_view_type": { - "type": "string", - "example": "public" - } + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "format": "uri" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" + "example": "https://github.com/orgs/rails/teams/core" }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", + "members_url": { "type": "string" }, - "description": { + "repositories_url": { "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true + "format": "uri" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "followers_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "following_url": { + "name": { + "description": "Name of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "Justice League" }, - "gists_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "nullable": true, + "example": "A great team." }, - "starred_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "admin" }, - "subscriptions_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "closed" }, - "organizations_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "notifications_enabled" }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "https://github.com/orgs/rails/teams/core" }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "starred_at": { + "slug": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "justice-league" }, - "user_view_type": { - "type": "string", - "example": "public" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } }, "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" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ], "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true } }, "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", "id", "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", + "members_url", + "name", + "description", + "permission", "html_url", - "patch_url", - "url" + "repositories_url", + "slug", + "parent" ] }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" + "name": { + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "description": { + "type": "string" }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "slug": { + "type": "string" }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri" }, - "subscriptions_url": { + "sync_to_organizations": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "disabled | all" }, - "organizations_url": { + "organization_selection_type": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "disabled | all" }, - "repos_url": { + "group_id": { + "nullable": true, "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "62ab9291-fae2-468e-974b-7e45096d5021" }, - "events_url": { + "group_name": { + "nullable": true, "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "Justice League" }, - "received_events_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true + "example": "https://github.com/enterprises/dc/teams/justice-league" }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true + "members_url": { + "type": "string" }, "created_at": { "type": "string", - "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", - "description": "The time the issue type last updated.", "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." } }, "required": [ "id", - "node_id", + "url", + "members_url", "name", - "description" + "html_url", + "slug", + "created_at", + "updated_at" ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", + } + ], + "nullable": true + }, + "pending_cancellation_date": { + "type": "string", + "format": "date", + "nullable": true, + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": "string", + "nullable": true, + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] + } + }, + "required": [ + "created_at" + ], + "additionalProperties": false + } + } + } + }, + "examples": { + "default": { + "value": { + "total_seats": 2, + "seats": [ + { + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "plan_type": "business", + "assignee": { + "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 + }, + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/selected_teams": { + "post": { + "summary": "Add teams to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-copilot-seats-for-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_teams": { + "type": "array", + "description": "List of team names within the organization to which to grant access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_teams" + ] + }, + "examples": { + "default": { + "value": { + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats created for members of the specified team(s).", + "properties": { + "seats_created": { + "type": "integer" + } + }, + "required": [ + "seats_created" + ] + }, + "examples": { + "default": { + "value": { + "seats_created": 5 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + }, + "delete": { + "summary": "Remove teams from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_teams": { + "type": "array", + "description": "The names of teams from which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_teams" + ] + }, + "examples": { + "default": { + "value": { + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", + "properties": { + "seats_cancelled": { + "type": "integer" + } + }, + "required": [ + "seats_cancelled" + ] + }, + "examples": { + "default": { + "value": { + "seats_cancelled": 5 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/selected_users": { + "post": { + "summary": "Add users to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-copilot-seats-for-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members to be granted access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats created for the specified user(s).", + "properties": { + "seats_created": { + "type": "integer" + } + }, + "required": [ + "seats_created" + ] + }, + "examples": { + "default": { + "value": { + "seats_created": 5 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + }, + "delete": { + "summary": "Remove users from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/cancel-copilot-seat-assignment-for-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", + "properties": { + "seats_cancelled": { + "type": "integer" + } + }, + "required": [ + "seats_cancelled" + ] + }, + "examples": { + "default": { + "value": { + "seats_cancelled": 5 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": "object", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { "type": "object", "properties": { - "key": { - "type": "string", - "example": "mit" - }, "name": { "type": "string", - "example": "MIT License" + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." }, - "spdx_id": { + "custom_model_training_date": { "type": "string", "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" + "description": "The training date for the custom model." }, - "push": { - "type": "boolean" + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." }, - "maintain": { - "type": "boolean" + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { "type": "object", "properties": { "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." }, - "organizations_url": { + "custom_model_training_date": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "nullable": true, + "description": "The training date for the custom model." }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." }, - "type": { + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in GitHub.com", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": "object", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { "type": "string", - "example": "User" + "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." }, - "site_admin": { - "type": "boolean" + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." }, - "starred_at": { + "custom_model_training_date": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "nullable": true, + "description": "The training date for the custom model." }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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" + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." }, - "lexical_commit_sha": { - "type": "string" + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." } } } - }, - "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" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at" - ] - }, - "comment": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] - }, - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": "string" - }, - "title": { - "type": "string" - }, - "summary": { - "type": "string", - "nullable": true - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" } } } } } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time", - "nullable": true } }, "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] + "date" + ], + "additionalProperties": true } }, "examples": { - "200-response": { + "default": { "value": [ { - "id": "22237752260", - "type": "WatchEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octo-org/octo-repo", - "url": "https://api.github.com/repos/octo-org/octo-repo" - }, - "payload": { - "action": "started" - }, - "public": true, - "created_at": "2022-06-08T23:29:25Z" - }, - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] }, - "repo": { - "id": 1296269, - "name": "octo-org/octo-repo", - "url": "https://api.github.com/repos/octo-org/oct-repo" + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] }, - "payload": { - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 } ] }, - "public": true, - "created_at": "2022-06-09T12:47:28Z" + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } } ] } } } } + }, + "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" + } + } + } + } + } + }, + "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": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "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": "activity", - "subcategory": "events" + "category": "copilot", + "subcategory": "copilot-metrics" } } }, - "/orgs/{org}/failed_invitations": { + "/orgs/{org}/dependabot/alerts": { "get": { - "summary": "List failed organization invitations", - "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", + "summary": "List Dependabot alerts for an organization", + "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/list-failed-invitations", + "operationId": "dependabot/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations" + "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" }, "parameters": [ { @@ -89771,21 +85282,154 @@ } }, { - "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).\"", + "name": "state", + "in": "query", + "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", + "schema": { + "type": "string" + } + }, + { + "name": "severity", + "in": "query", + "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", + "schema": { + "type": "string" + } + }, + { + "name": "package", + "in": "query", + "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "has", + "in": "query", + "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "patch" + ] + } + } + ] + } + }, + { + "name": "scope", + "in": "query", + "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", + "schema": { + "type": "string", + "enum": [ + "development", + "runtime" + ] + } + }, + { + "name": "sort", + "in": "query", + "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "epss_percentage" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "first", + "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", "in": "query", + "required": false, "schema": { "type": "integer", + "minimum": 1, + "maximum": 100, "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).\"", + "name": "last", + "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", "in": "query", + "required": false, "schema": { "type": "integer", - "default": 1 + "minimum": 1, + "maximum": 100 + } + }, + { + "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 } } ], @@ -89797,37 +85441,505 @@ "schema": { "type": "array", "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", "type": "object", + "description": "A Dependabot alert.", "properties": { - "id": { + "number": { "type": "integer", - "format": "int64" + "description": "The security alert number.", + "readOnly": true }, - "login": { + "state": { "type": "string", - "nullable": true + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "auto_dismissed", + "dismissed", + "fixed", + "open" + ] }, - "email": { + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": "string", + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "nullable": true, + "enum": [ + "development", + "runtime" + ] + }, + "relationship": { + "type": "string", + "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", + "readOnly": true, + "nullable": true, + "enum": [ + "unknown", + "direct", + "transitive" + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true, + "nullable": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": "object", + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "nullable": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": "string", + "description": "The full CVSS vector string for the advisory.", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cvss_severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "epss": { + "type": "object", + "nullable": true, + "readOnly": true, + "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", + "properties": { + "percentage": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "percentile": { + "type": "number", + "minimum": 0, + "maximum": 100 + } + } + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": "string", + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": "object", + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "nullable": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "url": { "type": "string", - "nullable": true + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "role": { - "type": "string" + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "failed_at": { + "updated_at": { "type": "string", - "nullable": true + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "failed_reason": { + "dismissed_at": { "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, "nullable": true }, - "inviter": { + "dismissed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -89949,83 +86061,965 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, - "team_count": { - "type": "integer" + "dismissed_reason": { + "type": "string", + "description": "The reason that the alert was dismissed.", + "nullable": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk" + ] }, - "node_id": { + "dismissed_comment": { "type": "string", - "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "description": "An optional comment associated with the alert's dismissal.", + "nullable": true, + "maxLength": 280 }, - "invitation_teams_url": { + "fixed_at": { "type": "string", - "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "invitation_source": { + "auto_dismissed_at": { "type": "string", - "example": "\"member\"" - } - }, - "required": [ - "id", - "login", - "email", - "role", + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "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": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", + "html_url", "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at", + "repository" + ], + "additionalProperties": false } }, "examples": { "default": { "value": [ { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, + "epss": [ + { + "percentage": 0.00045, + "percentile": "0.16001e0" + } + ], + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", + "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", + "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 }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" + } + }, + { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "repository": { + "id": 664700648, + "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", + "name": "hello-world", + "full_name": "octo-org/hello-world", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/hello-world", + "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", + "events_url": "https://api.github.com/repos/octo-org/hello-world/events", + "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", + "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", + "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", + "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", + "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", + "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" + } } ] } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "304": { + "description": "Not modified" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } } } } @@ -90055,27 +87049,57 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "members" + "category": "dependabot", + "subcategory": "alerts" } } }, - "/orgs/{org}/hooks": { + "/orgs/{org}/dependabot/secrets": { "get": { - "summary": "List organization webhooks", - "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/list-webhooks", + "operationId": "dependabot/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks" + "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" }, "parameters": [ { @@ -90112,121 +87136,86 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" - }, - "name": { - "type": "string", - "example": "web" - }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "example": true - }, - "config": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" }, - "insecure_ssl": { + "created_at": { "type": "string", - "example": "\"0\"" + "format": "date-time" }, - "content_type": { + "updated_at": { "type": "string", - "example": "\"form\"" + "format": "date-time" }, - "secret": { + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { "type": "string", - "example": "\"********\"" + "format": "uri", + "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" - }, - "type": { - "type": "string" + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] + } } }, "examples": { "default": { - "value": [ - { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" + "value": { + "total_count": 3, + "secrets": [ + { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "private" }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - ] + { + "name": "NPM_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" + } + ] + } } } } @@ -90239,51 +87228,27 @@ } } } - }, - "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": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } - }, - "post": { - "summary": "Create an organization webhook", - "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + } + }, + "/orgs/{org}/dependabot/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/create-webhook", + "operationId": "dependabot/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -90296,320 +87261,37 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Must be passed as \"web\"." - }, - "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } - ] - }, - "username": { - "type": "string", - "example": "\"kdaigle\"" - }, - "password": { - "type": "string", - "example": "\"password\"" - } - }, - "required": [ - "url" - ] - }, - "events": { - "type": "array", - "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", - "default": [ - "push" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "default": true - } - }, - "required": [ - "name", - "config" - ] - }, - "examples": { - "default": { - "value": { - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "url": "http://example.com/webhook", - "content_type": "json" - } - } - } - } - } - } - }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Org Hook", - "description": "Org Hook", + "title": "DependabotPublicKey", + "description": "The public key used for setting Dependabot Secrets.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" - }, - "name": { - "type": "string", - "example": "web" - }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "example": true - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" - }, - "insecure_ssl": { - "type": "string", - "example": "\"0\"" - }, - "content_type": { - "type": "string", - "example": "\"form\"" - }, - "secret": { - "type": "string", - "example": "\"********\"" - } - } - }, - "updated_at": { + "key_id": { + "description": "The identifier for the key.", "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" + "example": "1234567" }, - "created_at": { + "key": { + "description": "The Base64 encoded public key.", "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" - }, - "type": { - "type": "string" + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" } }, "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" + "key_id", + "key" ] }, "examples": { "default": { "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/orgs/octocat/hooks/1", - "schema": { - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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" + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } @@ -90620,22 +87302,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/hooks/{hook_id}": { + "/orgs/{org}/dependabot/secrets/{secret_name}": { "get": { - "summary": "Get an organization webhook", - "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/get-webhook", + "operationId": "dependabot/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" }, "parameters": [ { @@ -90648,12 +87330,12 @@ } }, { - "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.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -90663,141 +87345,53 @@ "content": { "application/json": { "schema": { - "title": "Org Hook", - "description": "Org Hook", + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" }, - "deliveries_url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + "format": "date-time" }, - "name": { + "updated_at": { "type": "string", - "example": "web" + "format": "date-time" }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "example": true - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" - }, - "insecure_ssl": { - "type": "string", - "example": "\"0\"" - }, - "content_type": { - "type": "string", - "example": "\"form\"" - }, - "secret": { - "type": "string", - "example": "\"********\"" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" + "type": "string" }, - "created_at": { + "selected_repositories_url": { "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" - }, - "type": { - "type": "string" + "format": "uri", + "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" } }, "required": [ - "id", - "url", - "type", "name", - "active", - "events", - "config", - "ping_url", "created_at", - "updated_at" + "updated_at", + "visibility" ] }, "examples": { "default": { "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - } - }, - "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": "NPM_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" } } } @@ -90808,20 +87402,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } }, - "patch": { - "summary": "Update an organization webhook", - "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/update-webhook", + "operationId": "dependabot/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -90834,86 +87428,61 @@ } }, { - "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.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } - ] - } - }, - "required": [ - "url" + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" ] }, - "events": { + "selected_repository_ids": { "type": "array", - "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", - "default": [ - "push" - ], + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "string" } - }, - "active": { - "type": "boolean", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "default": true - }, - "name": { - "type": "string", - "example": "\"web\"" } - } + }, + "required": [ + "visibility" + ] }, "examples": { "default": { "value": { - "active": true, - "events": [ - "pull_request" + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + "1296269", + "1296280" ] } } @@ -90922,238 +87491,46 @@ } }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "Response when creating a secret", "content": { "application/json": { "schema": { - "title": "Org Hook", - "description": "Org Hook", + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" - }, - "name": { - "type": "string", - "example": "web" - }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "example": true - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" - }, - "insecure_ssl": { - "type": "string", - "example": "\"0\"" - }, - "content_type": { - "type": "string", - "example": "\"form\"" - }, - "secret": { - "type": "string", - "example": "\"********\"" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] + "properties": {}, + "additionalProperties": false }, "examples": { "default": { - "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "name": "web", - "events": [ - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - } - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } + "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" - } - } - } - } - } + "204": { + "description": "Response when updating a secret" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } }, "delete": { - "summary": "Delete an organization webhook", - "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/delete-webhook", + "operationId": "dependabot/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -91166,157 +87543,39 @@ } }, { - "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.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "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" - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/hooks/{hook_id}/config": { + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { "get": { - "summary": "Get a webhook configuration for an organization", - "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/get-webhook-config-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Webhook Configuration", - "description": "Configuration object of the webhook", - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" - } - }, - "patch": { - "summary": "Update a webhook configuration for an organization", - "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", - "tags": [ - "orgs" - ], - "operationId": "orgs/update-webhook-config-for-org", + "operationId": "dependabot/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -91329,144 +87588,8 @@ } }, { - "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.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "summary": "Update an existing webhook", - "value": { - "url": "http://example.com/webhook", - "content_type": "json", - "insecure_ssl": "0", - "secret": "********" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Webhook Configuration", - "description": "Configuration object of the webhook", - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" - } - } - }, - "/orgs/{org}/hooks/{hook_id}/deliveries": { - "get": { - "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-webhook-deliveries", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -91474,12 +87597,12 @@ } }, { - "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.", - "in": "path", - "required": true, + "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" + "type": "integer", + "default": 1 } }, { @@ -91490,15 +87613,6 @@ "type": "integer", "default": 30 } - }, - { - "name": "cursor", - "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { @@ -91507,259 +87621,777 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple webhook delivery", - "description": "Delivery made by a webhook, without request and response information.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the webhook delivery.", - "type": "integer", - "format": "int64", - "example": 42 - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" - }, - "delivered_at": { - "description": "Time when the webhook delivery occurred.", - "type": "string", - "format": "date-time", - "example": "2021-05-12T20:33:44Z" - }, - "redelivery": { - "description": "Whether the webhook delivery is a redelivery.", - "type": "boolean", - "example": false - }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "example": 0.03 - }, - "status": { - "description": "Describes the response returned after attempting the delivery.", - "type": "string", - "example": "failed to connect" - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "example": 502 - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "example": "issues" - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": "string", - "example": "opened", - "nullable": true - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": "integer", - "format": "int64", - "example": 123, - "nullable": true - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": "integer", - "format": "int64", - "example": 123, - "nullable": true - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": "string", - "format": "date-time", - "example": "2021-05-12T20:33:44Z", - "nullable": true - } - }, - "required": [ - "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 12345678, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-03T00:57:16Z", - "redelivery": false, - "duration": 0.27, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "throttled_at": "2019-06-03T00:57:16Z" - }, - { - "id": 123456789, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-04T00:57:16Z", - "redelivery": true, - "duration": 0.28, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "throttled_at": null - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "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" + "total_count", + "repositories" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "repositories": { "type": "array", "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "field": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "message": { + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "code": { + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { "type": "string" }, - "index": { + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { "type": "integer" }, - "value": { - "oneOf": [ - { + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "nullable": true + "example": "contributor_covenant" }, - { - "type": "integer", + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } } } - ] + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } + }, + "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" + ] } } } + }, + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } } } } @@ -91768,22 +88400,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } - } - }, - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { - "get": { - "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/get-webhook-delivery", + "operationId": "dependabot/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -91796,363 +88426,70 @@ } }, { - "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.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "delivery_id", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Webhook delivery", - "description": "Delivery made by a webhook.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the delivery.", - "type": "integer", - "example": 42 - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" - }, - "delivered_at": { - "description": "Time when the delivery was delivered.", - "type": "string", - "format": "date-time", - "example": "2021-05-12T20:33:44Z" - }, - "redelivery": { - "description": "Whether the delivery is a redelivery.", - "type": "boolean", - "example": false - }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "example": 0.03 - }, - "status": { - "description": "Description of the status of the attempted delivery", - "type": "string", - "example": "failed to connect" - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "example": 502 - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "example": "issues" - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": "string", - "example": "opened", - "nullable": true - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": "integer", - "example": 123, - "nullable": true - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": "integer", - "example": 123, - "nullable": true - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": "string", - "format": "date-time", - "example": "2021-05-12T20:33:44Z", - "nullable": true - }, - "url": { - "description": "The URL target of the delivery.", - "type": "string", - "example": "https://www.example.com" - }, - "request": { - "type": "object", - "properties": { - "headers": { - "description": "The request headers sent with the webhook delivery.", - "type": "object", - "nullable": true, - "additionalProperties": true - }, - "payload": { - "description": "The webhook payload.", - "type": "object", - "nullable": true, - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - }, - "response": { - "type": "object", - "properties": { - "headers": { - "description": "The response headers received when the delivery was made.", - "type": "object", - "nullable": true, - "additionalProperties": true - }, - "payload": { - "description": "The response payload received.", - "type": "string", - "nullable": true, - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - } - }, - "required": [ - "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id", - "request", - "response" - ] - }, - "examples": { - "default": { - "value": { - "id": 12345678, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-03T00:57:16Z", - "redelivery": false, - "duration": 0.27, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "url": "https://www.example.com", - "throttled_at": "2019-06-03T00:57:16Z", - "request": { - "headers": { - "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "Accept": "*/*", - "X-GitHub-Hook-ID": "42", - "User-Agent": "GitHub-Hookshot/b8c71d8", - "X-GitHub-Event": "issues", - "X-GitHub-Hook-Installation-Target-ID": "123", - "X-GitHub-Hook-Installation-Target-Type": "repository", - "content-type": "application/json", - "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" - }, - "payload": { - "action": "opened", - "issue": { - "body": "foo" - }, - "repository": { - "id": 123 - } - } - }, - "response": { - "headers": { - "Content-Type": "text/html;charset=utf-8" - }, - "payload": "ok" - } - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] } } } } } }, + "responses": { + "204": { + "description": "Response" + } + }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { - "post": { - "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/redeliver-webhook-delivery", + "operationId": "dependabot/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -92165,16 +88502,16 @@ } }, { - "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.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "delivery_id", + "name": "repository_id", "in": "path", "required": true, "schema": { @@ -92183,170 +88520,30 @@ } ], "responses": { - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "400": { - "description": "Bad Request", - "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } + "204": { + "description": "No Content when repository was added to the selected list" }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } + "409": { + "description": "Conflict when visibility type is not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } - } - }, - "/orgs/{org}/hooks/{hook_id}/pings": { - "post": { - "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/ping-webhook", + "operationId": "dependabot/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -92359,8 +88556,16 @@ } }, { - "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.", + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", "in": "path", "required": true, "schema": { @@ -92370,54 +88575,31 @@ ], "responses": { "204": { - "description": "Response" + "description": "Response when repository was removed from the selected list" }, - "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 when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + "/orgs/{org}/docker/conflicts": { "get": { - "summary": "Get route stats by actor", - "description": "Get API request count statistics for an actor broken down by route within a specified time frame.", + "summary": "Get list of conflicting packages during Docker migration for organization", + "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", "tags": [ - "orgs" + "packages" ], - "operationId": "api-insights/get-route-stats-by-actor", + "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor" + "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" }, "parameters": [ { @@ -92428,111 +88610,6 @@ "schema": { "type": "string" } - }, - { - "name": "actor_type", - "in": "path", - "description": "The type of the actor", - "required": true, - "schema": { - "type": "string", - "enum": [ - "installation", - "classic_pat", - "fine_grained_pat", - "oauth_app", - "github_app_user_to_server" - ] - } - }, - { - "name": "actor_id", - "in": "path", - "description": "The ID of the actor", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "last_rate_limited_timestamp", - "last_request_timestamp", - "rate_limited_request_count", - "http_method", - "api_route", - "total_request_count" - ], - "default": "total_request_count" - } - } - }, - { - "name": "api_route_substring", - "in": "query", - "description": "Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { @@ -92541,926 +88618,1026 @@ "content": { "application/json": { "schema": { - "title": "Route Stats", - "description": "API Insights usage route stats for an actor", "type": "array", "items": { + "title": "Package", + "description": "A software package", "type": "object", "properties": { - "http_method": { - "description": "The HTTP method", - "type": "string" + "id": { + "description": "Unique identifier of the package.", + "type": "integer", + "example": 1 }, - "api_route": { - "description": "The API path's route template", - "type": "string" + "name": { + "description": "The name of the package.", + "type": "string", + "example": "super-linter" }, - "total_request_count": { - "description": "The total number of requests within the queried time period", - "type": "integer", - "format": "int64" + "package_type": { + "type": "string", + "example": "docker", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] }, - "rate_limited_request_count": { - "description": "The total number of requests that were rate limited within the queried time period", + "url": { + "type": "string", + "example": "https://api.github.com/orgs/github/packages/container/super-linter" + }, + "html_url": { + "type": "string", + "example": "https://github.com/orgs/github/packages/container/package/super-linter" + }, + "version_count": { + "description": "The number of versions of the package.", "type": "integer", - "format": "int64" + "example": 1 }, - "last_rate_limited_timestamp": { + "visibility": { "type": "string", - "nullable": true + "example": "private", + "enum": [ + "private", + "public" + ] }, - "last_request_timestamp": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "http_method": "GET", - "api_route": "/repositories/:repository_id", - "total_request_count": 544665, - "rate_limited_request_count": 13, - "last_request_timestamp": "2024-09-18T15:43:03Z", - "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" - } - ] - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/subject-stats": { - "get": { - "summary": "Get subject stats", - "description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-subject-stats", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-subject-stats" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "last_rate_limited_timestamp", - "last_request_timestamp", - "rate_limited_request_count", - "subject_name", - "total_request_count" - ], - "default": "total_request_count" - } - } - }, - { - "name": "subject_name_substring", - "in": "query", - "description": "Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Subject Stats", - "description": "API Insights usage subject stats for an organization", - "type": "array", - "items": { - "type": "object", - "properties": { - "subject_type": { - "type": "string" - }, - "subject_name": { - "type": "string" - }, - "subject_id": { - "type": "integer", - "format": "int64" - }, - "total_request_count": { - "type": "integer" + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "rate_limited_request_count": { - "type": "integer" + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "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" + ], + "nullable": true }, - "last_rate_limited_timestamp": { + "created_at": { "type": "string", - "nullable": true + "format": "date-time" }, - "last_request_timestamp": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time" } - } + }, + "required": [ + "id", + "name", + "package_type", + "visibility", + "url", + "html_url", + "version_count", + "created_at", + "updated_at" + ] } }, "examples": { "default": { "value": [ { - "subject_type": "installation", - "subject_id": 954453, - "subject_name": "GitHub Actions", - "integration_id": 124345, - "total_request_count": 544665, - "rate_limited_request_count": 13, - "last_request_timestamp": "2024-09-18T15:43:03Z", - "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + "id": 197, + "name": "hello_docker", + "package_type": "container", + "owner": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "version_count": 1, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker", + "created_at": "2020-05-19T22:19:11Z", + "updated_at": "2020-05-19T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" + }, + { + "id": 198, + "name": "goodbye_docker", + "package_type": "container", + "owner": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "version_count": 2, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", + "created_at": "2020-05-20T22:19:11Z", + "updated_at": "2020-05-20T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" } ] } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/summary-stats": { - "get": { - "summary": "Get summary stats", - "description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-summary-stats", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Summary Stats", - "description": "API Insights usage summary stats for an organization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_request_count": { - "description": "The total number of requests within the queried time period", - "type": "integer", - "format": "int64" + "message": { + "type": "string" }, - "rate_limited_request_count": { - "description": "The total number of requests that were rate limited within the queried time period", - "type": "integer", - "format": "int64" - } - } - }, - "examples": { - "default": { - "value": { - "total_request_count": 34225, - "rate_limited_request_count": 23 - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { - "get": { - "summary": "Get summary stats by user", - "description": "Get overall statistics of API requests within the organization for a user.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-summary-stats-by-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "user_id", - "in": "path", - "description": "The ID of the user to query for stats", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Summary Stats", - "description": "API Insights usage summary stats for an organization", - "type": "object", - "properties": { - "total_request_count": { - "description": "The total number of requests within the queried time period", - "type": "integer", - "format": "int64" + "documentation_url": { + "type": "string" }, - "rate_limited_request_count": { - "description": "The total number of requests that were rate limited within the queried time period", - "type": "integer", - "format": "int64" - } - } - }, - "examples": { - "default": { - "value": { - "total_request_count": 34225, - "rate_limited_request_count": 23 + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { - "get": { - "summary": "Get summary stats by actor", - "description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-summary-stats-by-actor", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "actor_type", - "in": "path", - "description": "The type of the actor", - "required": true, - "schema": { - "type": "string", - "enum": [ - "installation", - "classic_pat", - "fine_grained_pat", - "oauth_app", - "github_app_user_to_server" - ] - } }, - { - "name": "actor_id", - "in": "path", - "description": "The ID of the actor", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { - "title": "Summary Stats", - "description": "API Insights usage summary stats for an organization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_request_count": { - "description": "The total number of requests within the queried time period", - "type": "integer", - "format": "int64" + "message": { + "type": "string" }, - "rate_limited_request_count": { - "description": "The total number of requests that were rate limited within the queried time period", - "type": "integer", - "format": "int64" - } - } - }, - "examples": { - "default": { - "value": { - "total_request_count": 34225, - "rate_limited_request_count": 23 - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/time-stats": { - "get": { - "summary": "Get time stats", - "description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-time-stats", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "timestamp_increment", - "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Time Stats", - "description": "API Insights usage time stats for an organization", - "type": "array", - "items": { - "type": "object", - "properties": { - "timestamp": { - "type": "string" - }, - "total_request_count": { - "type": "integer", - "format": "int64" - }, - "rate_limited_request_count": { - "type": "integer", - "format": "int64" - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "timestamp": "2024-09-11T15:00:00Z", - "total_request_count": 34225, - "rate_limited_request_count": 0 - }, - { - "timestamp": "2024-09-11T15:05:00Z", - "total_request_count": 10587, - "rate_limited_request_count": 18 - }, - { - "timestamp": "2024-09-11T15:10:00Z", - "total_request_count": 43587, - "rate_limited_request_count": 14 - }, - { - "timestamp": "2024-09-11T15:15:00Z", - "total_request_count": 19463, - "rate_limited_request_count": 4 - }, - { - "timestamp": "2024-09-11T15:20:00Z", - "total_request_count": 60542, - "rate_limited_request_count": 3 - }, - { - "timestamp": "2024-09-11T15:25:00Z", - "total_request_count": 55872, - "rate_limited_request_count": 23 - } - ] - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/time-stats/users/{user_id}": { - "get": { - "summary": "Get time stats by user", - "description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-time-stats-by-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "user_id", - "in": "path", - "description": "The ID of the user to query for stats", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "timestamp_increment", - "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Time Stats", - "description": "API Insights usage time stats for an organization", - "type": "array", - "items": { - "type": "object", - "properties": { - "timestamp": { - "type": "string" - }, - "total_request_count": { - "type": "integer", - "format": "int64" - }, - "rate_limited_request_count": { - "type": "integer", - "format": "int64" - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "timestamp": "2024-09-11T15:00:00Z", - "total_request_count": 34225, - "rate_limited_request_count": 0 - }, - { - "timestamp": "2024-09-11T15:05:00Z", - "total_request_count": 10587, - "rate_limited_request_count": 18 - }, - { - "timestamp": "2024-09-11T15:10:00Z", - "total_request_count": 43587, - "rate_limited_request_count": 14 - }, - { - "timestamp": "2024-09-11T15:15:00Z", - "total_request_count": 19463, - "rate_limited_request_count": 4 - }, - { - "timestamp": "2024-09-11T15:20:00Z", - "total_request_count": 60542, - "rate_limited_request_count": 3 - }, - { - "timestamp": "2024-09-11T15:25:00Z", - "total_request_count": 55872, - "rate_limited_request_count": 23 - } - ] - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { - "get": { - "summary": "Get time stats by actor", - "description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-time-stats-by-actor", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "actor_type", - "in": "path", - "description": "The type of the actor", - "required": true, - "schema": { - "type": "string", - "enum": [ - "installation", - "classic_pat", - "fine_grained_pat", - "oauth_app", - "github_app_user_to_server" - ] - } - }, - { - "name": "actor_id", - "in": "path", - "description": "The ID of the actor", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "timestamp_increment", - "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Time Stats", - "description": "API Insights usage time stats for an organization", - "type": "array", - "items": { - "type": "object", - "properties": { - "timestamp": { - "type": "string" - }, - "total_request_count": { - "type": "integer", - "format": "int64" - }, - "rate_limited_request_count": { - "type": "integer", - "format": "int64" - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": [ - { - "timestamp": "2024-09-11T15:00:00Z", - "total_request_count": 34225, - "rate_limited_request_count": 0 - }, - { - "timestamp": "2024-09-11T15:05:00Z", - "total_request_count": 10587, - "rate_limited_request_count": 18 - }, - { - "timestamp": "2024-09-11T15:10:00Z", - "total_request_count": 43587, - "rate_limited_request_count": 14 - }, - { - "timestamp": "2024-09-11T15:15:00Z", - "total_request_count": 19463, - "rate_limited_request_count": 4 - }, - { - "timestamp": "2024-09-11T15:20:00Z", - "total_request_count": 60542, - "rate_limited_request_count": 3 - }, - { - "timestamp": "2024-09-11T15:25:00Z", - "total_request_count": 55872, - "rate_limited_request_count": 23 - } - ] - } } } } } }, "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } } }, - "/orgs/{org}/insights/api/user-stats/{user_id}": { + "/orgs/{org}/events": { "get": { - "summary": "Get user stats", - "description": "Get API usage statistics within an organization for a user broken down by the type of access.", + "summary": "List public organization events", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ - "orgs" + "activity" ], - "operationId": "api-insights/get-user-stats", + "operationId": "activity/list-public-org-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-user-stats" + "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" }, "parameters": [ { @@ -93472,42 +89649,6 @@ "type": "string" } }, - { - "name": "user_id", - "in": "path", - "description": "The ID of the user to query for stats", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, { "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).\"", @@ -93518,46 +89659,12 @@ } }, { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "last_rate_limited_timestamp", - "last_request_timestamp", - "rate_limited_request_count", - "subject_name", - "total_request_count" - ], - "default": "total_request_count" - } - } - }, - { - "name": "actor_name_substring", + "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", - "description": "Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.", - "required": false, "schema": { - "type": "string" + "type": "integer", + "default": 1 } } ], @@ -93567,1076 +89674,186 @@ "content": { "application/json": { "schema": { - "title": "User Stats", - "description": "API Insights usage stats for a user", "type": "array", "items": { + "title": "Event", + "description": "Event", "type": "object", "properties": { - "actor_type": { - "type": "string" - }, - "actor_name": { + "id": { "type": "string" }, - "actor_id": { - "type": "integer", - "format": "int64" - }, - "integration_id": { - "type": "integer", - "format": "int64", - "nullable": true - }, - "oauth_application_id": { - "type": "integer", - "format": "int64", - "nullable": true - }, - "total_request_count": { - "type": "integer" - }, - "rate_limited_request_count": { - "type": "integer" - }, - "last_rate_limited_timestamp": { + "type": { "type": "string", "nullable": true }, - "last_request_timestamp": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "actor_type": "oauth_app", - "actor_id": 954453, - "actor_name": "GitHub Actions", - "oauth_application_id": 1245, - "total_request_count": 544665, - "rate_limited_request_count": 13, - "last_request_timestamp": "2024-09-18T15:43:03Z", - "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" - } - ] - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/installation": { - "get": { - "summary": "Get an organization installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/get-org-installation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" - }, - "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": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "account": { - "nullable": true, - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "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" - ] + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/app/installations/1/access_tokens" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/installation/repositories" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/organizations/github/settings/installations/1" - }, - "app_id": { - "type": "integer", - "example": 1 - }, - "client_id": { - "type": "string", - "example": "Iv1.ab1112223334445c" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "example": "Organization" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for custom property management.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "has_multiple_single_files": { - "type": "boolean", - "example": true - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" + "required": [ + "id", + "name", + "url" + ] }, - "example": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "example": "github-actions" - }, - "suspended_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "org": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "contact_email": { - "type": "string", - "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", - "nullable": true - } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "account": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/orgs/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - }, - "repository_selection": "all", - "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/github/settings/installations/1", - "app_id": 1, - "client_id": "Iv1.ab1112223334445c", - "target_id": 1, - "target_type": "Organization", - "permissions": { - "checks": "write", - "metadata": "read", - "contents": "read" + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] }, - "events": [ - "push", - "pull_request" - ], - "created_at": "2018-02-09T20:51:14Z", - "updated_at": "2018-02-09T20:51:14Z", - "single_file_name": "config.yml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "apps", - "subcategory": "apps" - } - } - }, - "/orgs/{org}/installations": { - "get": { - "summary": "List app installations for an organization", - "description": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\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:read` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-app-installations", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#list-app-installations-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/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": { - "type": "object", - "required": [ - "total_count", - "installations" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "installations": { - "type": "array", - "items": { - "title": "Installation", - "description": "Installation", + "payload": { "type": "object", "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 + "action": { + "type": "string" }, - "account": { - "nullable": true, - "anyOf": [ - { + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -94758,1057 +89975,2640 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/enterprises/octo-business" + "example": "https://github.com/octocat" }, - "website_url": { - "description": "The enterprise's website URL.", + "followers_url": { "type": "string", - "nullable": true, - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" + "type": "integer", + "example": 1002604 }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, - "name": { - "description": "The name of the enterprise.", + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", "type": "string", - "example": "Octo Business" + "enum": [ + "open", + "closed" + ], + "default": "open" }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { "type": "string", - "example": "octo-business" + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 }, "created_at": { "type": "string", - "nullable": true, "format": "date-time", - "example": "2019-01-26T19:01:12Z" + "example": "2011-04-10T20:09:31Z" }, "updated_at": { "type": "string", - "nullable": true, "format": "date-time", - "example": "2019-01-26T19:14:43Z" + "example": "2014-03-03T18:58:10Z" }, - "avatar_url": { + "closed_at": { "type": "string", - "format": "uri" + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true } }, "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", "id", "node_id", - "name", - "slug", + "labels_url", "html_url", + "number", + "open_issues", + "state", + "title", + "url", "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/app/installations/1/access_tokens" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/installation/repositories" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/organizations/github/settings/installations/1" - }, - "app_id": { - "type": "integer", - "example": 1 - }, - "client_id": { - "type": "string", - "example": "Iv1.ab1112223334445c" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "example": "Organization" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] + "updated_at" + ], + "nullable": true }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] + "locked": { + "type": "boolean" }, - "organization_custom_org_roles": { + "active_lock_reason": { "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] + "nullable": true }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for custom property management.", - "enum": [ - "read", - "write", - "admin" - ] + "comments": { + "type": "integer" }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "organization_announcement_banners": { + "closed_at": { "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] + "format": "date-time", + "nullable": true }, - "organization_events": { + "created_at": { "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] + "format": "date-time" }, - "organization_hooks": { + "updated_at": { "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] + "draft": { + "type": "boolean" }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] + "body_html": { + "type": "string" }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] + "body_text": { + "type": "string" }, - "organization_packages": { + "timeline_url": { "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" ] }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" ] }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, - "gpg_keys": { + "author_association": { + "title": "author_association", "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "example": "OWNER", + "description": "How the author is associated with the repository.", "enum": [ - "read", - "write" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" ] }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] } }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "has_multiple_single_files": { - "type": "boolean", - "example": true - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "config.yml", - ".github/issue_TEMPLATE.md" + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" ] }, - "app_slug": { - "type": "string", - "example": "github-actions" - }, - "suspended_by": { - "title": "Simple User", - "description": "A GitHub user.", + "comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the issue comment", + "example": 42, "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "type": "string" }, "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "format": "uri" }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "body_text": { + "type": "string" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "body_html": { + "type": "string" }, - "subscriptions_url": { + "html_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "repos_url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "events_url": { + "updated_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "received_events_url": { + "issue_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" }, - "type": { + "author_association": { + "title": "author_association", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] }, - "user_view_type": { - "type": "string", - "example": "public" + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] }, - "contact_email": { - "type": "string", - "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", - "nullable": true + "pages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "page_name": { + "type": "string" + }, + "title": { + "type": "string" + }, + "summary": { + "type": "string", + "nullable": true + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + } } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" - ] + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true } - } + }, + "required": [ + "id", + "type", + "actor", + "repo", + "payload", + "public", + "created_at" + ] } }, "examples": { - "default": { - "value": { - "total_count": 1, - "installations": [ - { - "id": 25381, - "account": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "repository_selection": "selected", - "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/octo-org/settings/installations/25381", - "app_id": 2218, - "target_id": 6811672, - "target_type": "Organization", - "permissions": { - "deployments": "write", - "metadata": "read", - "pull_requests": "read", - "statuses": "read" - }, - "events": [ - "deployment", - "deployment_status" - ], - "created_at": "2017-05-16T08:47:09.000-07:00", - "updated_at": "2017-06-06T11:23:23.000-07:00", - "single_file_name": "config.yml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/interaction-limits": { - "get": { - "summary": "Get interaction restrictions for an organization", - "description": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.", - "tags": [ - "interactions" - ], - "operationId": "interactions/get-restrictions-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-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": { - "anyOf": [ - { - "title": "Interaction Limits", - "description": "Interaction limit settings.", - "type": "object", - "properties": { - "limit": { - "type": "string", - "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", - "example": "collaborators_only", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ] + "200-response": { + "value": [ + { + "id": "22237752260", + "type": "WatchEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, - "origin": { - "type": "string", - "example": "repository" + "repo": { + "id": 1296269, + "name": "octo-org/octo-repo", + "url": "https://api.github.com/repos/octo-org/octo-repo" }, - "expires_at": { - "type": "string", - "format": "date-time", - "example": "2018-08-17T04:18:39Z" - } + "payload": { + "action": "started" + }, + "public": true, + "created_at": "2022-06-08T23:29:25Z" }, - "required": [ - "limit", - "origin", - "expires_at" - ] - }, - { - "type": "object", - "properties": {}, - "additionalProperties": false - } - ] - }, - "examples": { - "default": { - "value": { - "limit": "collaborators_only", - "origin": "organization", - "expires_at": "2018-08-17T04:18:39Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "orgs" - } - }, - "put": { - "summary": "Set interaction restrictions for an organization", - "description": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.", - "tags": [ - "interactions" - ], - "operationId": "interactions/set-restrictions-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-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": { - "title": "Interaction Restrictions", - "description": "Limit interactions to a specific type of user for a specified duration", - "type": "object", - "properties": { - "limit": { - "type": "string", - "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", - "example": "collaborators_only", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ] - }, - "expiry": { - "type": "string", - "description": "The duration of the interaction restriction. Default: `one_day`.", - "example": "one_month", - "enum": [ - "one_day", - "three_days", - "one_week", - "one_month", - "six_months" - ] - } - }, - "required": [ - "limit" - ] - }, - "examples": { - "default": { - "value": { - "limit": "collaborators_only", - "expiry": "one_month" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Interaction Limits", - "description": "Interaction limit settings.", - "type": "object", - "properties": { - "limit": { - "type": "string", - "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", - "example": "collaborators_only", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ] - }, - "origin": { - "type": "string", - "example": "repository" - }, - "expires_at": { - "type": "string", - "format": "date-time", - "example": "2018-08-17T04:18:39Z" - } - }, - "required": [ - "limit", - "origin", - "expires_at" - ] - }, - "examples": { - "default": { - "value": { - "limit": "collaborators_only", - "origin": "organization", - "expires_at": "2018-08-17T04:18:39Z" - } - } - } - } - } - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octo-org/octo-repo", + "url": "https://api.github.com/repos/octo-org/oct-repo" + }, + "payload": { + "push_id": 10115855396, + "size": 1, + "distinct_size": 1, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd", + "commits": [ + { + "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "author": { + "email": "octocat@github.com", + "name": "Monalisa Octocat" }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + "message": "commit", + "distinct": true, + "url": "https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" + } + ] + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z" } - } + ] } } } @@ -95818,56 +92618,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "orgs" - } - }, - "delete": { - "summary": "Remove interaction restrictions for an organization", - "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", - "tags": [ - "interactions" - ], - "operationId": "interactions/remove-restrictions-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-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" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "orgs" + "category": "activity", + "subcategory": "events" } } }, - "/orgs/{org}/invitations": { + "/orgs/{org}/failed_invitations": { "get": { - "summary": "List pending organization invitations", - "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub\nmember, the `login` field in the return hash will be `null`.", + "summary": "List failed organization invitations", + "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", "tags": [ "orgs" ], - "operationId": "orgs/list-pending-invitations", + "operationId": "orgs/list-failed-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-pending-organization-invitations" + "url": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations" }, "parameters": [ { @@ -95896,38 +92662,6 @@ "type": "integer", "default": 1 } - }, - { - "name": "role", - "description": "Filter invitations by their member role.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "admin", - "direct_member", - "billing_manager", - "hiring_manager" - ], - "default": "all" - } - }, - { - "name": "invitation_source", - "description": "Filter invitations by their invitation source.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "member", - "scim" - ], - "default": "all" - } } ], "responses": { @@ -96204,17 +92938,227 @@ "category": "orgs", "subcategory": "members" } + } + }, + "/orgs/{org}/hooks": { + "get": { + "summary": "List organization webhooks", + "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-webhooks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks" + }, + "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/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": { + "type": "array", + "items": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + }, + "name": { + "type": "string", + "example": "web" + }, + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { + "type": "string", + "example": "\"0\"" + }, + "content_type": { + "type": "string", + "example": "\"form\"" + }, + "secret": { + "type": "string", + "example": "\"********\"" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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": "orgs", + "subcategory": "webhooks" + } }, "post": { - "summary": "Create an organization invitation", - "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "summary": "Create an organization webhook", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/create-invitation", + "operationId": "orgs/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#create-an-organization-invitation" + "url": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook" }, "parameters": [ { @@ -96228,49 +93172,95 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "invitee_id": { - "type": "integer", - "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting." - }, - "email": { + "name": { "type": "string", - "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user." + "description": "Must be passed as \"web\"." }, - "role": { - "type": "string", - "description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.", - "enum": [ - "admin", - "direct_member", - "billing_manager", - "reinstate" - ], - "default": "direct_member" + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook.", + "properties": { + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] + }, + "username": { + "type": "string", + "example": "\"kdaigle\"" + }, + "password": { + "type": "string", + "example": "\"password\"" + } + }, + "required": [ + "url" + ] }, - "team_ids": { + "events": { "type": "array", - "description": "Specify IDs for the teams you want to invite new members to.", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", + "default": [ + "push" + ], "items": { - "type": "integer" + "type": "string" } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true } - } + }, + "required": [ + "name", + "config" + ] }, "examples": { "default": { "value": { - "email": "octocat@github.com", - "role": "direct_member", - "team_ids": [ - 12, - 26 - ] + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "url": "http://example.com/webhook", + "content_type": "json" + } } } } @@ -96283,224 +93273,127 @@ "content": { "application/json": { "schema": { - "title": "Organization Invitation", - "description": "Organization Invitation", + "title": "Org Hook", + "description": "Org Hook", "type": "object", "properties": { "id": { "type": "integer", - "format": "int64" + "example": 1 }, - "login": { + "url": { "type": "string", - "nullable": true + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" }, - "email": { + "ping_url": { "type": "string", - "nullable": true - }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" }, - "failed_at": { + "deliveries_url": { "type": "string", - "nullable": true + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" }, - "failed_reason": { + "name": { "type": "string", - "nullable": true + "example": "web" }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "\"http://example.com/2\"" }, - "type": { + "insecure_ssl": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "\"0\"" }, - "starred_at": { + "content_type": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "\"form\"" }, - "user_view_type": { + "secret": { "type": "string", - "example": "public" + "example": "\"********\"" } - }, - "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" - ] - }, - "team_count": { - "type": "integer" + } }, - "node_id": { + "updated_at": { "type": "string", - "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "format": "date-time", + "example": "2011-09-06T20:39:23Z" }, - "invitation_teams_url": { + "created_at": { "type": "string", - "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "format": "date-time", + "example": "2011-09-06T17:26:27Z" }, - "invitation_source": { - "type": "string", - "example": "\"member\"" + "type": { + "type": "string" } }, "required": [ "id", - "login", - "email", - "role", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" + "updated_at" ] }, "examples": { "default": { "value": { "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" } } } } + }, + "headers": { + "Location": { + "example": "https://api.github.com/orgs/octocat/hooks/1", + "schema": { + "type": "string" + } + } } }, "422": { @@ -96600,25 +93493,24 @@ } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "members" + "subcategory": "webhooks" } } }, - "/orgs/{org}/invitations/{invitation_id}": { - "delete": { - "summary": "Cancel an organization invitation", - "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "/orgs/{org}/hooks/{hook_id}": { + "get": { + "summary": "Get an organization webhook", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/cancel-invitation", + "operationId": "orgs/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation" + "url": "https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook" }, "parameters": [ { @@ -96631,8 +93523,8 @@ } }, { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", + "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.", "in": "path", "required": true, "schema": { @@ -96641,8 +93533,388 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + }, + "name": { + "type": "string", + "example": "web" + }, + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { + "type": "string", + "example": "\"0\"" + }, + "content_type": { + "type": "string", + "example": "\"form\"" + }, + "secret": { + "type": "string", + "example": "\"********\"" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + } + } + } + } + }, + "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": "webhooks" + } + }, + "patch": { + "summary": "Update an organization webhook", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook.", + "properties": { + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] + } + }, + "required": [ + "url" + ] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + }, + "name": { + "type": "string", + "example": "\"web\"" + } + } + }, + "examples": { + "default": { + "value": { + "active": true, + "events": [ + "pull_request" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + }, + "name": { + "type": "string", + "example": "web" + }, + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { + "type": "string", + "example": "\"0\"" + }, + "content_type": { + "type": "string", + "example": "\"form\"" + }, + "secret": { + "type": "string", + "example": "\"********\"" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "name": "web", + "events": [ + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + } + } + } + } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", @@ -96741,25 +94013,22 @@ } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "members" + "subcategory": "webhooks" } - } - }, - "/orgs/{org}/invitations/{invitation_id}/teams": { - "get": { - "summary": "List organization invitation teams", - "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", + }, + "delete": { + "summary": "Delete an organization webhook", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/list-invitation-teams", + "operationId": "orgs/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-organization-invitation-teams" + "url": "https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook" }, "parameters": [ { @@ -96772,244 +94041,18 @@ } }, { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", + "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.", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "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": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -97042,21 +94085,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "members" + "subcategory": "webhooks" } } }, - "/orgs/{org}/issue-types": { + "/orgs/{org}/hooks/{hook_id}/config": { "get": { - "summary": "List issue types for an organization", - "description": "Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.", + "summary": "Get a webhook configuration for an organization", + "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/list-issue-types", + "operationId": "orgs/get-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization" + "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -97067,6 +94110,15 @@ "schema": { "type": "string" } + }, + { + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { @@ -97075,113 +94127,47 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 410, - "node_id": "IT_kwDNAd3NAZo", - "name": "Task", - "description": "A specific piece of work", - "created_at": "2024-12-11T14:39:09Z", - "updated_at": "2024-12-11T14:39:09Z" - }, - { - "id": 411, - "node_id": "IT_kwDNAd3NAZs", - "name": "Bug", - "description": "An unexpected problem or behavior", - "created_at": "2024-12-11T14:39:09Z", - "updated_at": "2024-12-11T14:39:09Z" - } - ] - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "message": { - "type": "string" + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" }, - "documentation_url": { - "type": "string" + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" }, - "url": { - "type": "string" + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" }, - "status": { - "type": "string" + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" } } } @@ -97193,19 +94179,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "issue-types" + "subcategory": "webhooks" } }, - "post": { - "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "patch": { + "summary": "Update a webhook configuration for an organization", + "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/create-issue-type", + "operationId": "orgs/update-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization" + "url": "https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -97216,56 +94202,62 @@ "schema": { "type": "string" } + }, + { + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "name": { - "description": "Name of the issue type.", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the issue type is enabled at the organization level.", - "type": "boolean" + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" }, - "description": { - "description": "Description of the issue type.", + "content_type": { "type": "string", - "nullable": true + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" }, - "color": { - "description": "Color for the issue type.", + "secret": { "type": "string", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] } - }, - "required": [ - "name", - "is_enabled" - ] + } }, "examples": { "default": { + "summary": "Update an existing webhook", "value": { - "name": "Epic", - "description": "An issue type for a multi-week tracking of work", - "is_enabled": true, - "color": "green" + "url": "http://example.com/webhook", + "content_type": "json", + "insecure_ssl": "0", + "secret": "********" } } } @@ -97278,130 +94270,47 @@ "content": { "application/json": { "schema": { - "title": "Issue Type", - "description": "The type of issue.", + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", - "nullable": true, "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { + "url": { "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" }, - "created_at": { + "content_type": { "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" }, - "updated_at": { + "secret": { "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + } }, "examples": { "default": { "value": { - "id": 410, - "node_id": "IT_kwDNAd3NAZo", - "name": "Task", - "description": "A specific piece of work", - "created_at": "2024-12-11T14:39:09Z", - "updated_at": "2024-12-11T14:39:09Z" - } - } - } - } - } - }, - "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 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" - } + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" } } } @@ -97413,21 +94322,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "issue-types" + "subcategory": "webhooks" } } }, - "/orgs/{org}/issue-types/{issue_type_id}": { - "put": { - "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/hooks/{hook_id}/deliveries": { + "get": { + "summary": "List deliveries for an organization webhook", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/update-issue-type", + "operationId": "orgs/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization" + "url": "https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" }, "parameters": [ { @@ -97440,151 +94349,538 @@ } }, { - "name": "issue_type_id", - "description": "The unique identifier of the issue type.", + "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.", "in": "path", "required": true, "schema": { "type": "integer" } + }, + { + "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": "cursor", + "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the issue type.", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the issue type is enabled at the organization level.", - "type": "boolean" - }, - "description": { - "description": "Description of the issue type.", - "type": "string", - "nullable": true - }, - "color": { - "description": "Color for the issue type.", - "type": "string", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Simple webhook delivery", + "description": "Delivery made by a webhook, without request and response information.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the webhook delivery.", + "type": "integer", + "format": "int64", + "example": 42 + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + }, + "delivered_at": { + "description": "Time when the webhook delivery occurred.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z" + }, + "redelivery": { + "description": "Whether the webhook delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Describes the response returned after attempting the delivery.", + "type": "string", + "example": "failed to connect" + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", + "nullable": true + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "format": "int64", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "format": "int64", + "example": 123, + "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + } + }, + "required": [ + "id", + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id" + ] } }, - "required": [ - "name", - "is_enabled" - ] + "examples": { + "default": { + "value": [ + { + "id": 12345678, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-03T00:57:16Z", + "redelivery": false, + "duration": 0.27, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "throttled_at": "2019-06-03T00:57:16Z" + }, + { + "id": 123456789, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-04T00:57:16Z", + "redelivery": true, + "duration": 0.28, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "throttled_at": null + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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": "Epic", - "description": "An issue type for a multi-week tracking of work", - "is_enabled": true, - "color": "green" + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } } } } } } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + "get": { + "summary": "Get a webhook delivery for an organization webhook", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "delivery_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Issue Type", - "description": "The type of issue.", + "title": "Webhook delivery", + "description": "Delivery made by a webhook.", "type": "object", - "nullable": true, "properties": { "id": { + "description": "Unique identifier of the delivery.", "type": "integer", - "description": "The unique identifier of the issue type." + "example": 42 }, - "node_id": { + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", - "description": "The node identifier of the issue type." + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" }, - "name": { + "delivered_at": { + "description": "Time when the delivery was delivered.", "type": "string", - "description": "The name of the issue type." + "format": "date-time", + "example": "2021-05-12T20:33:44Z" }, - "description": { + "redelivery": { + "description": "Whether the delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Description of the status of the attempted delivery", "type": "string", - "description": "The description of the issue type.", - "nullable": true + "example": "failed to connect" }, - "color": { + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", "nullable": true }, - "created_at": { + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true }, - "updated_at": { + "url": { + "description": "The URL target of the delivery.", "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" + "example": "https://www.example.com" }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "request": { + "type": "object", + "properties": { + "headers": { + "description": "The request headers sent with the webhook delivery.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The webhook payload.", + "type": "object", + "nullable": true, + "additionalProperties": true + } + }, + "required": [ + "headers", + "payload" + ] + }, + "response": { + "type": "object", + "properties": { + "headers": { + "description": "The response headers received when the delivery was made.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The response payload received.", + "type": "string", + "nullable": true, + "additionalProperties": true + } + }, + "required": [ + "headers", + "payload" + ] } }, "required": [ "id", - "node_id", - "name", - "description" + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id", + "request", + "response" ] }, "examples": { "default": { "value": { - "id": 410, - "node_id": "IT_kwDNAd3NAZo", - "name": "Task", - "description": "A specific piece of work", - "created_at": "2024-12-11T14:39:09Z", - "updated_at": "2024-12-11T14:39:09Z" + "id": 12345678, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-03T00:57:16Z", + "redelivery": false, + "duration": 0.27, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "url": "https://www.example.com", + "throttled_at": "2019-06-03T00:57:16Z", + "request": { + "headers": { + "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "Accept": "*/*", + "X-GitHub-Hook-ID": "42", + "User-Agent": "GitHub-Hookshot/b8c71d8", + "X-GitHub-Event": "issues", + "X-GitHub-Hook-Installation-Target-ID": "123", + "X-GitHub-Hook-Installation-Target-Type": "repository", + "content-type": "application/json", + "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" + }, + "payload": { + "action": "opened", + "issue": { + "body": "foo" + }, + "repository": { + "id": 123 + } + } + }, + "response": { + "headers": { + "Content-Type": "text/html;charset=utf-8" + }, + "payload": "ok" + } } } } } } }, - "404": { - "description": "Resource not found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -97606,6 +94902,40 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, @@ -97614,8 +94944,8 @@ "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -97631,7 +94961,46 @@ "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -97644,19 +95013,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "issue-types" + "subcategory": "webhooks" } - }, - "delete": { - "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for an organization webhook", + "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/delete-issue-type", + "operationId": "orgs/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization" + "url": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -97669,8 +95040,16 @@ } }, { - "name": "issue_type_id", - "description": "The unique identifier of the issue type.", + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "delivery_id", "in": "path", "required": true, "schema": { @@ -97679,16 +95058,88 @@ } ], "responses": { - "204": { - "description": "Response" + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -97704,13 +95155,97 @@ "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}/pings": { + "post": { + "summary": "Ping an organization webhook", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/ping-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -97743,21 +95278,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "issue-types" + "subcategory": "webhooks" } } }, - "/orgs/{org}/issues": { + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { "get": { - "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "summary": "Get route stats by actor", + "description": "Get API request count statistics for an actor broken down by route within a specified time frame.", "tags": [ - "issues" + "orgs" ], - "operationId": "issues/list-for-org", + "operationId": "api-insights/get-route-stats-by-actor", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor" }, "parameters": [ { @@ -97770,69 +95305,232 @@ } }, { - "name": "filter", - "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", - "in": "query", - "required": false, + "name": "actor_type", + "in": "path", + "description": "The type of the actor", + "required": true, "schema": { "type": "string", "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "default": "assigned" + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" + ] } }, { - "name": "state", - "description": "Indicates the state of the issues to return.", + "name": "actor_id", + "in": "path", + "description": "The ID of the actor", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", - "all" + "asc", + "desc" ], - "default": "open" + "default": "desc" } }, { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "name": "sort", + "description": "The property to sort the results by.", "in": "query", "required": false, "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "http_method", + "api_route", + "total_request_count" + ], + "default": "total_request_count" + } } }, { - "name": "type", - "description": "Can be the name of an issue type.", + "name": "api_route_substring", "in": "query", + "description": "Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.", "required": false, "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Route Stats", + "description": "API Insights usage route stats for an actor", + "type": "array", + "items": { + "type": "object", + "properties": { + "http_method": { + "description": "The HTTP method", + "type": "string" + }, + "api_route": { + "description": "The API path's route template", + "type": "string" + }, + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "http_method": "GET", + "api_route": "/repositories/:repository_id", + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/subject-stats": { + "get": { + "summary": "Get subject stats", + "description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-subject-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-subject-stats" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "sort", - "description": "What to sort results by.", + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "comments" - ], - "default": "created" + "type": "string" + } + }, + { + "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 + } + }, + { + "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 } }, { @@ -97850,31 +95548,427 @@ } }, { - "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "subject_name", + "total_request_count" + ], + "default": "total_request_count" + } + } + }, + { + "name": "subject_name_substring", + "in": "query", + "description": "Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Subject Stats", + "description": "API Insights usage subject stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "subject_type": { + "type": "string" + }, + "subject_name": { + "type": "string" + }, + "subject_id": { + "type": "integer", + "format": "int64" + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "subject_type": "installation", + "subject_id": 954453, + "subject_name": "GitHub Actions", + "integration_id": 124345, + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/summary-stats": { + "get": { + "summary": "Get summary stats", + "description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + }, + "examples": { + "default": { + "value": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + "get": { + "summary": "Get summary stats by user", + "description": "Get overall statistics of API requests within the organization for a user.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "user_id", + "in": "path", + "description": "The ID of the user to query for stats", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + }, + "examples": { + "default": { + "value": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get summary stats by actor", + "description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "actor_type", + "in": "path", + "description": "The type of the actor", + "required": true, "schema": { "type": "string", - "format": "date-time" + "enum": [ + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" + ] } }, { - "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).\"", + "name": "actor_id", + "in": "path", + "description": "The ID of the actor", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + }, + "examples": { + "default": { + "value": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/time-stats": { + "get": { + "summary": "Get time stats", + "description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } }, { - "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).\"", + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "schema": { - "type": "integer", - "default": 1 + "type": "string" + } + }, + { + "name": "timestamp_increment", + "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", + "in": "query", + "required": true, + "schema": { + "type": "string" } } ], @@ -97884,375 +95978,581 @@ "content": { "application/json": { "schema": { + "title": "Time Stats", + "description": "API Insights usage time stats for an organization", "type": "array", "items": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { - "id": { + "timestamp": { + "type": "string" + }, + "total_request_count": { "type": "integer", "format": "int64" }, - "node_id": { - "type": "string" + "rate_limited_request_count": { + "type": "integer", + "format": "int64" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "timestamp": "2024-09-11T15:00:00Z", + "total_request_count": 34225, + "rate_limited_request_count": 0 }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" + { + "timestamp": "2024-09-11T15:05:00Z", + "total_request_count": 10587, + "rate_limited_request_count": 18 }, - "repository_url": { - "type": "string", - "format": "uri" + { + "timestamp": "2024-09-11T15:10:00Z", + "total_request_count": 43587, + "rate_limited_request_count": 14 }, - "labels_url": { + { + "timestamp": "2024-09-11T15:15:00Z", + "total_request_count": 19463, + "rate_limited_request_count": 4 + }, + { + "timestamp": "2024-09-11T15:20:00Z", + "total_request_count": 60542, + "rate_limited_request_count": 3 + }, + { + "timestamp": "2024-09-11T15:25:00Z", + "total_request_count": 55872, + "rate_limited_request_count": 23 + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + "get": { + "summary": "Get time stats by user", + "description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "user_id", + "in": "path", + "description": "The ID of the user to query for stats", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "timestamp_increment", + "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Time Stats", + "description": "API Insights usage time stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { "type": "string" }, - "comments_url": { - "type": "string", - "format": "uri" + "total_request_count": { + "type": "integer", + "format": "int64" }, - "events_url": { - "type": "string", - "format": "uri" + "rate_limited_request_count": { + "type": "integer", + "format": "int64" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "timestamp": "2024-09-11T15:00:00Z", + "total_request_count": 34225, + "rate_limited_request_count": 0 }, - "html_url": { - "type": "string", - "format": "uri" + { + "timestamp": "2024-09-11T15:05:00Z", + "total_request_count": 10587, + "rate_limited_request_count": 18 }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" + { + "timestamp": "2024-09-11T15:10:00Z", + "total_request_count": 43587, + "rate_limited_request_count": 14 }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", + { + "timestamp": "2024-09-11T15:15:00Z", + "total_request_count": 19463, + "rate_limited_request_count": 4 + }, + { + "timestamp": "2024-09-11T15:20:00Z", + "total_request_count": 60542, + "rate_limited_request_count": 3 + }, + { + "timestamp": "2024-09-11T15:25:00Z", + "total_request_count": 55872, + "rate_limited_request_count": 23 + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get time stats by actor", + "description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "actor_type", + "in": "path", + "description": "The type of the actor", + "required": true, + "schema": { + "type": "string", + "enum": [ + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" + ] + } + }, + { + "name": "actor_id", + "in": "path", + "description": "The ID of the actor", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "timestamp_increment", + "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Time Stats", + "description": "API Insights usage time stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { "type": "string" }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", - "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] + "total_request_count": { + "type": "integer", + "format": "int64" }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "rate_limited_request_count": { + "type": "integer", + "format": "int64" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "timestamp": "2024-09-11T15:00:00Z", + "total_request_count": 34225, + "rate_limited_request_count": 0 + }, + { + "timestamp": "2024-09-11T15:05:00Z", + "total_request_count": 10587, + "rate_limited_request_count": 18 + }, + { + "timestamp": "2024-09-11T15:10:00Z", + "total_request_count": 43587, + "rate_limited_request_count": 14 + }, + { + "timestamp": "2024-09-11T15:15:00Z", + "total_request_count": 19463, + "rate_limited_request_count": 4 + }, + { + "timestamp": "2024-09-11T15:20:00Z", + "total_request_count": 60542, + "rate_limited_request_count": 3 + }, + { + "timestamp": "2024-09-11T15:25:00Z", + "total_request_count": 55872, + "rate_limited_request_count": 23 + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/user-stats/{user_id}": { + "get": { + "summary": "Get user stats", + "description": "Get API usage statistics within an organization for a user broken down by the type of access.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-user-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-user-stats" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "user_id", + "in": "path", + "description": "The ID of the user to query for stats", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "subject_name", + "total_request_count" + ], + "default": "total_request_count" + } + } + }, + { + "name": "actor_name_substring", + "in": "query", + "description": "Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "User Stats", + "description": "API Insights usage stats for a user", + "type": "array", + "items": { + "type": "object", + "properties": { + "actor_type": { "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "actor_name": { + "type": "string" + }, + "actor_id": { + "type": "integer", + "format": "int64" + }, + "integration_id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "oauth_application_id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { "type": "string", "nullable": true }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "actor_type": "oauth_app", + "actor_id": 954453, + "actor_name": "GitHub Actions", + "oauth_application_id": 1245, + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/installation": { + "get": { + "summary": "Get an organization installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-org-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" + }, + "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": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "account": { + "nullable": true, + "anyOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -98376,62 +96676,1507 @@ "url" ] }, - "nullable": true + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/app/installations/1/access_tokens" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/installation/repositories" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/organizations/github/settings/installations/1" + }, + "app_id": { + "type": "integer", + "example": 1 + }, + "client_id": { + "type": "string", + "example": "Iv1.ab1112223334445c" + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "example": "Organization" + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + } }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "example": "github-actions" + }, + "suspended_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "contact_email": { + "type": "string", + "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", + "nullable": true + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "account": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/orgs/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "all", + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "client_id": "Iv1.ab1112223334445c", + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "created_at": "2018-02-09T20:51:14Z", + "updated_at": "2018-02-09T20:51:14Z", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/orgs/{org}/installations": { + "get": { + "summary": "List app installations for an organization", + "description": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\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:read` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-app-installations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-app-installations-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/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": { + "type": "object", + "required": [ + "total_count", + "installations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "installations": { + "type": "array", + "items": { + "title": "Installation", + "description": "Installation", "type": "object", "properties": { - "url": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "account": { + "nullable": true, + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "example": "https://api.github.com/app/installations/1/access_tokens" }, - "html_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + "example": "https://api.github.com/installation/repositories" }, - "labels_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + "example": "https://github.com/organizations/github/settings/installations/1" }, - "id": { + "app_id": { "type": "integer", - "example": 1002604 + "example": 1 }, - "node_id": { + "client_id": { "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + "example": "Iv1.ab1112223334445c" }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" }, - "state": { - "description": "The state of the milestone.", - "example": "open", + "target_type": { "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" + "example": "Organization" }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } }, - "description": { + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { "type": "string", - "example": "Tracking milestone for version 1.0", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": "string", + "example": "config.yaml", "nullable": true }, - "creator": { + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "example": "github-actions" + }, + "suspended_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -98556,120 +98301,549 @@ ], "nullable": true }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { + "suspended_at": { "type": "string", "format": "date-time", - "example": "2013-02-12T13:22:01Z", "nullable": true }, - "due_on": { + "contact_email": { "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", + "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", "nullable": true } }, "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", "id", - "node_id", - "labels_url", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", "html_url", - "number", - "open_issues", - "state", - "title", - "url", + "repositories_url", + "events", + "account", + "permissions", "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true + "updated_at", + "suspended_by", + "suspended_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "installations": [ + { + "id": 25381, + "account": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true + "repository_selection": "selected", + "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/octo-org/settings/installations/25381", + "app_id": 2218, + "target_id": 6811672, + "target_type": "Organization", + "permissions": { + "deployments": "write", + "metadata": "read", + "pull_requests": "read", + "statuses": "read" }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } + "events": [ + "deployment", + "deployment_status" + ], + "created_at": "2017-05-16T08:47:09.000-07:00", + "updated_at": "2017-06-06T11:23:23.000-07:00", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/interaction-limits": { + "get": { + "summary": "Get interaction restrictions for an organization", + "description": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.", + "tags": [ + "interactions" + ], + "operationId": "interactions/get-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-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": { + "anyOf": [ + { + "title": "Interaction Limits", + "description": "Interaction limit settings.", + "type": "object", + "properties": { + "limit": { + "type": "string", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "example": "collaborators_only", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ] }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true + "origin": { + "type": "string", + "example": "repository" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "example": "2018-08-17T04:18:39Z" + } }, - "created_at": { + "required": [ + "limit", + "origin", + "expires_at" + ] + }, + { + "type": "object", + "properties": {}, + "additionalProperties": false + } + ] + }, + "examples": { + "default": { + "value": { + "limit": "collaborators_only", + "origin": "organization", + "expires_at": "2018-08-17T04:18:39Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + }, + "put": { + "summary": "Set interaction restrictions for an organization", + "description": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.", + "tags": [ + "interactions" + ], + "operationId": "interactions/set-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-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": { + "title": "Interaction Restrictions", + "description": "Limit interactions to a specific type of user for a specified duration", + "type": "object", + "properties": { + "limit": { + "type": "string", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "example": "collaborators_only", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ] + }, + "expiry": { + "type": "string", + "description": "The duration of the interaction restriction. Default: `one_day`.", + "example": "one_month", + "enum": [ + "one_day", + "three_days", + "one_week", + "one_month", + "six_months" + ] + } + }, + "required": [ + "limit" + ] + }, + "examples": { + "default": { + "value": { + "limit": "collaborators_only", + "expiry": "one_month" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Interaction Limits", + "description": "Interaction limit settings.", + "type": "object", + "properties": { + "limit": { + "type": "string", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "example": "collaborators_only", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ] + }, + "origin": { + "type": "string", + "example": "repository" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "example": "2018-08-17T04:18:39Z" + } + }, + "required": [ + "limit", + "origin", + "expires_at" + ] + }, + "examples": { + "default": { + "value": { + "limit": "collaborators_only", + "origin": "organization", + "expires_at": "2018-08-17T04:18:39Z" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Remove interaction restrictions for an organization", + "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", + "tags": [ + "interactions" + ], + "operationId": "interactions/remove-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-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" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/invitations": { + "get": { + "summary": "List pending organization invitations", + "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub\nmember, the `login` field in the return hash will be `null`.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pending-invitations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#list-pending-organization-invitations" + }, + "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/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 + } + }, + { + "name": "role", + "description": "Filter invitations by their member role.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "admin", + "direct_member", + "billing_manager", + "hiring_manager" + ], + "default": "all" + } + }, + { + "name": "invitation_source", + "description": "Filter invitations by their invitation source.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "member", + "scim" + ], + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { + "email": { "type": "string", - "format": "date-time" + "nullable": true }, - "draft": { - "type": "boolean" + "role": { + "type": "string" }, - "closed_by": { + "created_at": { + "type": "string" + }, + "failed_at": { + "type": "string", + "nullable": true + }, + "failed_reason": { + "type": "string", + "nullable": true + }, + "inviter": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -98791,1225 +98965,34 @@ "subscriptions_url", "type", "url" - ], - "nullable": true - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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" ] }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] + "team_count": { + "type": "integer" }, - "author_association": { - "title": "author_association", + "node_id": { "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + "invitation_teams_url": { + "type": "string", + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] + "invitation_source": { + "type": "string", + "example": "\"member\"" } }, "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", + "login", + "email", + "role", "created_at", - "updated_at" + "inviter", + "team_count", + "invitation_teams_url", + "node_id" ] } }, @@ -100018,263 +99001,36 @@ "value": [ { "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "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 - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "login": "octocat", + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "avatar_url": "https://github.com/images/error/other_user_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", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, - "assignees": [ - { - "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 - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "repository": { - "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 - }, - "author_association": "COLLABORATOR" + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" } ] } @@ -100319,23 +99075,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "issues", - "subcategory": "issues" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" } - } - }, - "/orgs/{org}/members": { - "get": { - "summary": "List organization members", - "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", + }, + "post": { + "summary": "Create an organization invitation", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "orgs" ], - "operationId": "orgs/list-members", + "operationId": "orgs/create-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-organization-members" + "url": "https://docs.github.com/rest/orgs/members#create-an-organization-invitation" }, "parameters": [ { @@ -100346,224 +99100,424 @@ "schema": { "type": "string" } - }, - { - "name": "filter", - "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "2fa_insecure", - "all" - ], - "default": "all" - } - }, - { - "name": "role", - "description": "Filter members returned by their role.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "admin", - "member" - ], - "default": "all" - } - }, - { - "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 - } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "invitee_id": { + "type": "integer", + "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting." + }, + "email": { + "type": "string", + "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user." + }, + "role": { + "type": "string", + "description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.", + "enum": [ + "admin", + "direct_member", + "billing_manager", + "reinstate" + ], + "default": "direct_member" + }, + "team_ids": { + "type": "array", + "description": "Specify IDs for the teams you want to invite new members to.", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "email": "octocat@github.com", + "role": "direct_member", + "team_ids": [ + 12, + 26 + ] + } + } + } + } + } + }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "nullable": true + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": "string", + "nullable": true + }, + "failed_reason": { + "type": "string", + "nullable": true + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user_view_type": { - "type": "string", - "example": "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" + ] }, - "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" - ] - } + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + }, + "invitation_teams_url": { + "type": "string", + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + }, + "invitation_source": { + "type": "string", + "example": "\"member\"" + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] }, "examples": { "default": { - "value": [ - { - "login": "octocat", + "value": { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "inviter": { + "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "avatar_url": "https://github.com/images/error/other_user_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", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } - ] + } } } } - }, - "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": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/invitations/{invitation_id}": { + "delete": { + "summary": "Cancel an organization invitation", + "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "tags": [ + "orgs" + ], + "operationId": "orgs/cancel-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", @@ -100633,9 +99587,36 @@ } } } + }, + "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": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", @@ -100643,17 +99624,17 @@ } } }, - "/orgs/{org}/members/{username}": { + "/orgs/{org}/invitations/{invitation_id}/teams": { "get": { - "summary": "Check organization membership for a user", - "description": "Check if a user is, publicly or privately, a member of the organization.", + "summary": "List organization invitation teams", + "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", "tags": [ "orgs" ], - "operationId": "orgs/check-membership-for-user", + "operationId": "orgs/list-invitation-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user" + "url": "https://docs.github.com/rest/orgs/members#list-organization-invitation-teams" }, "parameters": [ { @@ -100666,24 +99647,239 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "invitation_id", + "description": "The unique identifier of the invitation.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" + } + }, + { + "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": { - "204": { - "description": "Response if requester is an organization member and user is a member" - }, - "302": { - "description": "Response if requester is not an organization member", + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ] + } + } + } + }, "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members/pezra", + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } @@ -100691,7 +99887,30 @@ } }, "404": { - "description": "Not Found if requester is an organization member and user is not a member" + "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": { @@ -100700,17 +99919,19 @@ "category": "orgs", "subcategory": "members" } - }, - "delete": { - "summary": "Remove an organization member", - "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.\n\n> [!NOTE]\n> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.", + } + }, + "/orgs/{org}/issue-types": { + "get": { + "summary": "List issue types for an organization", + "description": "Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/remove-member", + "operationId": "orgs/list-issue-types", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#remove-an-organization-member" + "url": "https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization" }, "parameters": [ { @@ -100721,10 +99942,150 @@ "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 411, + "node_id": "IT_kwDNAd3NAZs", + "name": "Bug", + "description": "An unexpected problem or behavior", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ] + } + } + } + } }, + "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": "issue-types" + } + }, + "post": { + "summary": "Create issue type for an organization", + "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization" + }, + "parameters": [ { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -100732,12 +100093,142 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue type.", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the issue type is enabled at the organization level.", + "type": "boolean" + }, + "description": { + "description": "Description of the issue type.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the issue type.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + } + }, + "required": [ + "name", + "is_enabled" + ] + }, + "examples": { + "default": { + "value": { + "name": "Epic", + "description": "An issue type for a multi-week tracking of work", + "is_enabled": true, + "color": "green" + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "examples": { + "default": { + "value": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + } + } + } + } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -100761,47 +100252,288 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "members" + "subcategory": "issue-types" } } }, - "/orgs/{org}/members/{username}/codespaces": { - "get": { - "summary": "List codespaces for a user in organization", - "description": "Lists the codespaces that a member of an organization has for repositories in that organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/issue-types/{issue_type_id}": { + "put": { + "summary": "Update issue type for an organization", + "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "codespaces" + "orgs" ], - "operationId": "codespaces/get-codespaces-for-user-in-org", + "operationId": "orgs/update-issue-type", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization" + "url": "https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization" }, "parameters": [ { - "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", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } }, { - "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", + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue type.", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the issue type is enabled at the organization level.", + "type": "boolean" + }, + "description": { + "description": "Description of the issue type.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the issue type.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + } + }, + "required": [ + "name", + "is_enabled" + ] + }, + "examples": { + "default": { + "value": { + "name": "Epic", + "description": "An issue type for a multi-week tracking of work", + "is_enabled": true, + "color": "green" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "examples": { + "default": { + "value": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + } + } + } + } + }, + "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 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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + } + }, + "delete": { + "summary": "Delete issue type for an organization", + "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization" + }, + "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -100812,1415 +100544,2443 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", "required": [ - "total_count", - "codespaces" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "codespaces": { + "documentation_url": { + "type": "string" + }, + "errors": { "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + } + } + }, + "/orgs/{org}/issues": { + "get": { + "summary": "List organization issues assigned to the authenticated user", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "repos", + "all" + ], + "default": "assigned" + } + }, + { + "name": "state", + "description": "Indicates the state of the issues to return.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "What to sort results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "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": { + "type": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "title": "Codespace", - "description": "A codespace.", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { "type": "integer", "format": "int64", "example": 1 }, - "name": { - "description": "Automatically generated name of this codespace.", + "node_id": { "type": "string", - "example": "monalisa-octocat-hello-world-g4wpq6h95q" + "example": "MDQ6VXNlcjE=" }, - "display_name": { - "description": "Display name for this codespace.", + "avatar_url": { "type": "string", - "example": "bookish space pancake", - "nullable": true + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", + "gravatar_id": { "type": "string", - "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "billable_owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" }, - "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" - ] + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "email": { + "nullable": true, + "type": "string" }, - "description": { + "login": { "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" + "example": "octocat" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "archive_url": { + "node_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "MDQ6VXNlcjE=" }, - "assignees_url": { + "avatar_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "blobs_url": { + "gravatar_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "branches_url": { + "url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "collaborators_url": { + "html_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "format": "uri", + "example": "https://github.com/octocat" }, - "comments_url": { + "followers_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "commits_url": { + "following_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "compare_url": { + "gists_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "contents_url": { + "starred_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "contributors_url": { + "subscriptions_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/users/octocat/subscriptions" }, - "deployments_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/users/octocat/orgs" }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "forks_url": { + "received_events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/users/octocat/received_events" }, - "git_commits_url": { + "type": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "User" }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "site_admin": { + "type": "boolean" }, - "git_tags_url": { + "starred_at": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" + "example": "\"2020-07-09T00:17:55Z\"" }, - "issue_comment_url": { + "user_view_type": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "mit" }, - "issues_url": { + "name": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "MIT License" }, - "keys_url": { + "url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "labels_url": { + "spdx_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "nullable": true, + "example": "MIT" }, - "languages_url": { + "node_id": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "MDc6TGljZW5zZW1pdA==" }, - "merges_url": { + "html_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "pull": { + "type": "boolean" }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "triage": { + "type": "boolean" }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "push": { + "type": "boolean" }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "ssh_url": { + "email": { + "nullable": true, "type": "string" }, - "stargazers_url": { + "login": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "octocat" }, - "statuses_url": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "MDQ6VXNlcjE=" }, - "subscribers_url": { + "avatar_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://github.com/images/error/octocat_happy.gif" }, - "subscription_url": { + "gravatar_id": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "tags_url": { + "url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/users/octocat" }, - "teams_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://github.com/octocat" }, - "trees_url": { + "followers_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "mirror_url": { + "following_url": { "type": "string", - "nullable": true + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "hooks_url": { + "gists_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "homepage": { + "starred_url": { "type": "string", - "nullable": true + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "language": { + "subscriptions_url": { "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "pushed_at": { + "organizations_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "role_name": { + "received_events_url": { "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "watchers": { - "type": "integer", - "example": 0 + "type": { + "type": "string", + "example": "User" }, - "allow_forking": { + "site_admin": { "type": "boolean" }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "user_view_type": { + "type": "string", + "example": "public" } }, "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", + "avatar_url", "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "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", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", "url" ] }, - "machine": { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "example": "standardLinux" - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "example": "4 cores, 16 GB RAM, 64 GB storage" - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "example": "linux" - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "example": 68719476736 - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "example": 17179869184 - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "example": 4 - }, - "prebuild_availability": { - "type": "string", - "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", - "example": "ready", - "enum": [ - "none", - "ready", - "in_progress" - ], - "nullable": true - } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ], - "nullable": true + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", + "html_url": { "type": "string", - "example": ".devcontainer/example/devcontainer.json", - "nullable": true + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": "boolean", - "example": false, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "updated_at": { + "archive_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "last_used_at": { - "description": "Last known time this codespace was started.", + "assignees_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "state": { - "description": "State of this codespace.", - "enum": [ - "Unknown", - "Created", - "Queued", - "Provisioning", - "Available", - "Awaiting", - "Unavailable", - "Deleted", - "Moved", - "Shutdown", - "Archived", - "Starting", - "ShuttingDown", - "Failed", - "Exporting", - "Updating", - "Rebuilding" - ], - "example": "Available", - "type": "string" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "url": { - "description": "API URL for this codespace.", + "branches_url": { "type": "string", - "format": "uri" + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "git_status": { - "description": "Details about the codespace's git repository.", - "type": "object", - "properties": { - "ahead": { - "description": "The number of commits the local repository is ahead of the remote.", - "type": "integer", - "example": 0 - }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "example": 0 - }, - "has_unpushed_changes": { - "description": "Whether the local repository has unpushed changes.", - "type": "boolean" - }, - "has_uncommitted_changes": { - "description": "Whether the local repository has uncommitted changes.", - "type": "boolean" - }, - "ref": { - "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", - "type": "string", - "example": "main" - } - } + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "location": { - "description": "The initally assigned location of a new codespace.", - "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "example": "WestUs2", - "type": "string" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": "integer", - "example": 60, - "nullable": true + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "web_url": { - "description": "URL to access this codespace on the web.", + "compare_url": { "type": "string", - "format": "uri" + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "machines_url": { - "description": "API URL to access available alternate machine types for this codespace.", + "contents_url": { "type": "string", - "format": "uri" + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "start_url": { - "description": "API URL to start this codespace.", + "contributors_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "stop_url": { - "description": "API URL to stop this codespace.", + "deployments_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "publish_url": { - "description": "API URL to publish this codespace to a new repository.", + "downloads_url": { "type": "string", "format": "uri", - "nullable": true + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { "type": "string", "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, - "recent_folders": { + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { "type": "array", "items": { "type": "string" } }, - "runtime_constraints": { - "type": "object", - "properties": { - "allowed_port_privacy_settings": { - "description": "The privacy settings a user can select from when forwarding a port.", - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - } + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, - "pending_operation": { - "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, "type": "boolean", - "nullable": true + "example": true }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", - "type": "string", - "nullable": true + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", "nullable": true }, - "retention_period_minutes": { - "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", - "type": "integer", - "example": 60, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", "nullable": true }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "updated_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T20:01:12Z", + "example": "2011-01-26T19:14:43Z", "nullable": true }, - "last_known_stop_notice": { - "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", - "example": "you've used 100% of your spending limit for Codespaces", - "nullable": true + "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", + "example": 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", + "example": "\"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", - "environment_id", + "notifications_url", "owner", - "billable_owner", - "repository", - "machine", - "prebuild", - "created_at", - "updated_at", - "last_used_at", - "state", - "url", - "git_status", - "location", - "idle_timeout_minutes", - "web_url", - "machines_url", - "start_url", - "stop_url", + "private", "pulls_url", - "recent_folders" + "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": 3, - "codespaces": [ - { - "id": 1, - "name": "monalisa-octocat-hello-world-g4wpq6h95q", - "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "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 + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" }, - "billable_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 + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" }, - "repository": { - "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 + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } }, - "prebuild": false, - "devcontainer_path": ".devcontainer/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", - "recent_folders": [] + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - { + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", "id": 1, - "name": "monalisa-octocat-hello-world-3f89ada1j3", - "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", - "owner": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -102239,8 +102999,19 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "billable_owner": { + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -102260,109 +103031,30 @@ "type": "User", "site_admin": false }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer/foobar/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", - "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": [] + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, @@ -102383,209 +103075,116 @@ "type": "User", "site_admin": false }, - "billable_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 - }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 + "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 }, - "prebuild": false, - "devcontainer_path": ".devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "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" }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", - "recent_folders": [] - } - ] - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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" - } + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "author_association": "COLLABORATOR" + } + ] } } } - } - }, - "403": { - "description": "Forbidden", - "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" } } } @@ -102620,22 +103219,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "category": "issues", + "subcategory": "issues" } } }, - "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { - "delete": { - "summary": "Delete a codespace from the organization", - "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/members": { + "get": { + "summary": "List organization members", + "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", "tags": [ - "codespaces" + "orgs" ], - "operationId": "codespaces/delete-from-organization", + "operationId": "orgs/list-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization" + "url": "https://docs.github.com/rest/orgs/members#list-organization-members" }, "parameters": [ { @@ -102648,77 +103247,235 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, + "name": "filter", + "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "2fa_disabled", + "2fa_insecure", + "all" + ], + "default": "all" } }, { - "name": "codespace_name", - "in": "path", - "required": true, - "description": "The name of the codespace.", + "name": "role", + "description": "Filter members returned by their role.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "all", + "admin", + "member" + ], + "default": "all" + } + }, + { + "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": { - "202": { - "description": "Accepted", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "type": "object" + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + } }, "examples": { "default": { - "value": null + "value": [ + { + "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 + } + ] } } } - } - }, - "304": { - "description": "Not modified" - }, - "500": { - "description": "Internal Error", - "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" } } } }, - "401": { - "description": "Requires authentication", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -102726,45 +103483,160 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/members/{username}": { + "get": { + "summary": "Check organization membership for a user", + "description": "Check if a user is, publicly or privately, a member of the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if requester is an organization member and user is a member" + }, + "302": { + "description": "Response if requester is not an organization member", + "headers": { + "Location": { + "example": "https://api.github.com/orgs/github/public_members/pezra", "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" } } } }, "404": { - "description": "Resource not found", + "description": "Not Found if requester is an organization member and user is not a member" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove an organization member", + "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.\n\n> [!NOTE]\n> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-member", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#remove-an-organization-member" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -102792,37 +103664,46 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" } } }, - "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { - "post": { - "summary": "Stop a codespace for an organization user", - "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/members/{username}/codespaces": { + "get": { + "summary": "List codespaces for a user in organization", + "description": "Lists the codespaces that a member of an organization has for repositories in that organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], - "operationId": "codespaces/stop-in-organization", + "operationId": "codespaces/get-codespaces-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user" + "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "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": "string" + "type": "integer", + "default": 30 } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "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 + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -102830,10 +103711,10 @@ } }, { - "name": "codespace_name", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, - "description": "The name of the codespace.", "schema": { "type": "string" } @@ -102846,500 +103727,2518 @@ "application/json": { "schema": { "type": "object", - "title": "Codespace", - "description": "A codespace.", + "required": [ + "total_count", + "codespaces" + ], "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "Automatically generated name of this codespace.", - "type": "string", - "example": "monalisa-octocat-hello-world-g4wpq6h95q" - }, - "display_name": { - "description": "Display name for this codespace.", - "type": "string", - "example": "bookish space pancake", - "nullable": true - }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", - "type": "string", - "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "nullable": true - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - "billable_owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] + "total_count": { + "type": "integer" }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "codespaces": { + "type": "array", + "items": { + "type": "object", + "title": "Codespace", + "description": "A codespace.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "example": "monalisa-octocat-hello-world-g4wpq6h95q" + }, + "display_name": { + "description": "Display name for this codespace.", + "type": "string", + "example": "bookish space pancake", + "nullable": true + }, + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": "string", + "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "nullable": true + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "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" + ] + }, + "machine": { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "example": "standardLinux" + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "example": "4 cores, 16 GB RAM, 64 GB storage" + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "example": "linux" + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "example": 68719476736 + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "example": 17179869184 + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "example": 4 + }, + "prebuild_availability": { + "type": "string", + "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", + "example": "ready", + "enum": [ + "none", + "ready", + "in_progress" + ], + "nullable": true + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ], + "nullable": true + }, + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", + "type": "string", + "example": ".devcontainer/example/devcontainer.json", + "nullable": true + }, + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": "boolean", + "example": false, + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "last_used_at": { + "description": "Last known time this codespace was started.", + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "state": { + "description": "State of this codespace.", + "enum": [ + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "example": "Available", + "type": "string" + }, + "url": { + "description": "API URL for this codespace.", + "type": "string", + "format": "uri" + }, + "git_status": { + "description": "Details about the codespace's git repository.", + "type": "object", + "properties": { + "ahead": { + "description": "The number of commits the local repository is ahead of the remote.", + "type": "integer", + "example": 0 + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "example": 0 + }, + "has_unpushed_changes": { + "description": "Whether the local repository has unpushed changes.", + "type": "boolean" + }, + "has_uncommitted_changes": { + "description": "Whether the local repository has uncommitted changes.", + "type": "boolean" + }, + "ref": { + "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", + "type": "string", + "example": "main" + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "example": "WestUs2", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": "integer", + "example": 60, + "nullable": true + }, + "web_url": { + "description": "URL to access this codespace on the web.", + "type": "string", + "format": "uri" + }, + "machines_url": { + "description": "API URL to access available alternate machine types for this codespace.", + "type": "string", + "format": "uri" + }, + "start_url": { + "description": "API URL to start this codespace.", + "type": "string", + "format": "uri" + }, + "stop_url": { + "description": "API URL to stop this codespace.", + "type": "string", + "format": "uri" + }, + "publish_url": { + "description": "API URL to publish this codespace to a new repository.", + "type": "string", + "format": "uri", + "nullable": true + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": "string", + "format": "uri", + "nullable": true + }, + "recent_folders": { + "type": "array", + "items": { + "type": "string" + } + }, + "runtime_constraints": { + "type": "object", + "properties": { + "allowed_port_privacy_settings": { + "description": "The privacy settings a user can select from when forwarding a port.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + }, + "pending_operation": { + "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", + "type": "boolean", + "nullable": true + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": "string", + "nullable": true + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": "string", + "nullable": true + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer", + "example": 60, + "nullable": true + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": "string", + "format": "date-time", + "example": "2011-01-26T20:01:12Z", + "nullable": true + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": "string", + "example": "you've used 100% of your spending limit for Codespaces", + "nullable": true + } + }, + "required": [ + "id", + "name", + "environment_id", + "owner", + "billable_owner", + "repository", + "machine", + "prebuild", + "created_at", + "updated_at", + "last_used_at", + "state", + "url", + "git_status", + "location", + "idle_timeout_minutes", + "web_url", + "machines_url", + "start_url", + "stop_url", + "pulls_url", + "recent_folders" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "codespaces": [ + { + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/foobar/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "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": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-f8adfad99a", + "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", + "recent_folders": [] + } + ] + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": false, + "category": "codespaces", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { + "delete": { + "summary": "Delete a codespace from the organization", + "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-from-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "codespace_name", + "in": "path", + "required": true, + "description": "The name of the codespace.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": false, + "category": "codespaces", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { + "post": { + "summary": "Stop a codespace for an organization user", + "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/stop-in-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "codespace_name", + "in": "path", + "required": true, + "description": "The name of the codespace.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Codespace", + "description": "A codespace.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "example": "monalisa-octocat-hello-world-g4wpq6h95q" + }, + "display_name": { + "description": "Display name for this codespace.", + "type": "string", + "example": "bookish space pancake", + "nullable": true + }, + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": "string", + "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "nullable": true + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { @@ -104344,7 +107243,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -139625,6 +142524,639 @@ } } }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "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": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update organization pattern configurations", + "description": "Updates the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "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": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, "/orgs/{org}/security-advisories": { "get": { "summary": "List repository security advisories for an organization", @@ -171763,199 +175295,1044 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true, + "allowed_actions": "selected" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/access": { + "get": { + "summary": "Get the level of access for workflows outside of the repository", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-access-to-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_level": { + "type": "string", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", + "enum": [ + "none", + "user", + "organization" + ] + } + }, + "required": [ + "access_level" + ] + }, + "examples": { + "default": { + "value": { + "access_level": "organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set the level of access for workflows outside of the repository", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-workflow-access-to-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_level": { + "type": "string", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", + "enum": [ + "none", + "user", + "organization" + ] + } + }, + "required": [ + "access_level" + ] + }, + "examples": { + "default": { + "value": { + "access_level": "organization" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for a repository", + "description": "Gets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "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": { + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "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" + } + }, + "put": { + "summary": "Set artifact and log retention settings for a repository", + "description": "Sets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "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": { + "default": { + "summary": "Set retention days", + "value": { + "days": 90 + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for a repository", + "description": "Gets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for a repository", + "description": "Sets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for a repository", + "description": "Gets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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 + } + } + } + } + } + }, + "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, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for a repository", + "description": "Sets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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": { - "enabled": { + "run_workflows_from_fork_pull_requests": { "type": "boolean", - "description": "Whether GitHub Actions is enabled on the repository." + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "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" - ] + "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." } - }, - "required": [ - "enabled" - ] + } }, "examples": { "default": { "value": { - "enabled": true, - "allowed_actions": "selected" + "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 } } } } } }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/repos/{owner}/{repo}/actions/permissions/access": { - "get": { - "summary": "Get the level of access for workflows outside of the repository", - "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-workflow-access-to-repository", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Empty response for successful settings update" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "access_level": { - "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", - "enum": [ - "none", - "user", - "organization" - ] - } - }, - "required": [ - "access_level" - ] - }, - "examples": { - "default": { - "value": { - "access_level": "organization" + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set the level of access for workflows outside of the repository", - "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/set-workflow-access-to-repository", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", - "enum": [ - "none", - "user", - "organization" - ] - } - }, - "required": [ - "access_level" - ] - }, - "examples": { - "default": { - "value": { - "access_level": "organization" + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], "category": "actions", "subcategory": "permissions" } @@ -278083,6 +282460,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -297907,6 +302308,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -300480,6 +304905,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -302817,496 +307266,3872 @@ "url" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "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 + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + }, + "delete": { + "summary": "Delete an issue comment", + "description": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.", + "tags": [ + "issues" + ], + "operationId": "issues/delete-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#delete-an-issue-comment" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + "get": { + "summary": "List reactions for an issue comment", + "description": "List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", + "tags": [ + "reactions" + ], + "operationId": "reactions/list-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { + "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": { + "type": "array", + "items": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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": "reactions", + "subcategory": "reactions" + } + }, + "post": { + "summary": "Create reaction for an issue comment", + "description": "Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", + "tags": [ + "reactions" + ], + "operationId": "reactions/create-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "heart" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Reaction exists", + "content": { + "application/json": { + "schema": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + } + } + } + } + }, + "201": { + "description": "Reaction created", + "content": { + "application/json": { + "schema": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete an issue comment reaction", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "reaction_id", + "description": "The unique identifier of the reaction.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/issues/events": { + "get": { + "summary": "List issue events for a repository", + "description": "Lists events for a repository.", + "tags": [ + "issues" + ], + "operationId": "issues/list-events-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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/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": { + "type": "array", + "items": { + "title": "Issue Event", + "description": "Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEwOklzc3VlRXZlbnQx" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "event": { + "type": "string", + "example": "closed" + }, + "commit_id": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "commit_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" + "additionalProperties": { + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri" + "example": { + "issues": "read", + "deployments": "write" } }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } }, - "contents": { - "type": "string" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - "deployments": { - "type": "string" - } + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "additionalProperties": { - "type": "string" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "user": { - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - } - } - } - } - } - }, - "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": { + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ], + "nullable": true + }, + "label": { + "title": "Issue Event Label", + "description": "Issue Event Label", "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + }, "required": [ - "code" - ], + "name", + "color" + ] + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "resource": { + "name": { + "nullable": true, "type": "string" }, - "field": { + "email": { + "nullable": true, "type": "string" }, - "message": { - "type": "string" + "login": { + "type": "string", + "example": "octocat" }, - "code": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "index": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "comments" - } - }, - "delete": { - "summary": "Delete an issue comment", - "description": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.", - "tags": [ - "issues" - ], - "operationId": "issues/delete-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#delete-an-issue-comment" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "comments" - } - } - }, - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { - "get": { - "summary": "List reactions for an issue comment", - "description": "List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-issue-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "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": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "user": { + "assigner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -303431,818 +311256,132 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for an issue comment", - "description": "Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-issue-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Reaction exists", - "content": { - "application/json": { - "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - }, - "201": { - "description": "Reaction created", - "content": { - "application/json": { - "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - }, - "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": { + "review_requester": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "name": { + "nullable": true, "type": "string" }, - "field": { + "email": { + "nullable": true, "type": "string" }, - "message": { - "type": "string" + "login": { + "type": "string", + "example": "octocat" }, - "code": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "index": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete an issue comment reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-issue-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/repos/{owner}/{repo}/issues/events": { - "get": { - "summary": "List issue events for a repository", - "description": "Lists events for a repository.", - "tags": [ - "issues" - ], - "operationId": "issues/list-events-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. 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/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": { - "type": "array", - "items": { - "title": "Issue Event", - "description": "Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEwOklzc3VlRXZlbnQx" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "actor": { + "requested_reviewer": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -304367,96 +311506,1447 @@ ], "nullable": true }, - "event": { - "type": "string", - "example": "closed" + "requested_team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] }, - "commit_id": { - "type": "string", - "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true + "dismissed_review": { + "title": "Issue Event Dismissed Review", + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": "string", + "nullable": true + }, + "dismissal_commit_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" + ] }, - "commit_url": { + "milestone": { + "title": "Issue Event Milestone", + "description": "Issue Event Milestone", + "type": "object", + "properties": { + "title": { + "type": "string" + } + }, + "required": [ + "title" + ] + }, + "project_card": { + "title": "Issue Event Project Card", + "description": "Issue Event Project Card", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "url", + "id", + "project_url", + "project_id", + "column_name" + ] + }, + "rename": { + "title": "Issue Event Rename", + "description": "Issue Event Rename", + "type": "object", + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + }, + "required": [ + "from", + "to" + ] + }, + "author_association": { + "title": "author_association", "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, - "created_at": { + "lock_reason": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "nullable": true }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "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 + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { + "resource": { "type": "string" }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { + "field": { "type": "string" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" + "message": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "code": { + "type": "string" }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, + "index": { "type": "integer" }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", - "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/events/{event_id}": { + "get": { + "summary": "Get an issue event", + "description": "Gets a single event by the event id.", + "tags": [ + "issues" + ], + "operationId": "issues/get-event", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/events#get-an-issue-event" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "event_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue Event", + "description": "Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEwOklzc3VlRXZlbnQx" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "event": { + "type": "string", + "example": "closed" + }, + "commit_id": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "commit_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", - "type": "string", - "nullable": true + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -304578,2337 +313068,3505 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { "oneOf": [ { - "type": "string" + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] }, { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true }, - "node_id": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" }, - "url": { + "website_url": { + "description": "The enterprise's website URL.", "type": "string", + "nullable": true, "format": "uri" }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, "name": { - "type": "string" + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" }, - "description": { + "slug": { + "description": "The slug url identifier for the enterprise.", "type": "string", - "nullable": true + "example": "octo-business" }, - "color": { + "created_at": { "type": "string", - "nullable": true + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" }, - "default": { - "type": "boolean" + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" } - } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] } ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "name": { - "nullable": true, + "issues": { "type": "string" }, - "email": { - "nullable": true, + "checks": { "type": "string" }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "metadata": { + "type": "string" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "contents": { + "type": "string" }, - "user_view_type": { - "type": "string", - "example": "public" + "deployments": { + "type": "string" } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", + "additionalProperties": { "type": "string" }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true + "example": { + "issues": "read", + "deployments": "write" } }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "body_html": { - "type": "string" + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } }, - "body_text": { - "type": "string" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - "timeline_url": { - "type": "string", - "format": "uri" + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ], + "nullable": true + }, + "label": { + "title": "Issue Event Label", + "description": "Issue Event Label", + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "color" + ] + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assigner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "review_requester": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "requested_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "requested_team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" }, - "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" - ] + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "dismissed_review": { + "title": "Issue Event Dismissed Review", + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": "string", + "nullable": true + }, + "dismissal_commit_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" + ] + }, + "milestone": { + "title": "Issue Event Milestone", + "description": "Issue Event Milestone", + "type": "object", + "properties": { + "title": { + "type": "string" + } + }, + "required": [ + "title" + ] + }, + "project_card": { + "title": "Issue Event Project Card", + "description": "Issue Event Project Card", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "url", + "id", + "project_url", + "project_id", + "column_name" + ] + }, + "rename": { + "title": "Issue Event Rename", + "description": "Issue Event Rename", + "type": "object", + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + }, + "required": [ + "from", + "to" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "lock_reason": { + "type": "string", + "nullable": true + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "additionalProperties": { + "email": { + "nullable": true, "type": "string" }, - "example": { - "issues": "read", - "deployments": "write" + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } + "checks": { + "type": "string" }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } + "metadata": { + "type": "string" }, - "required": [ - "total", - "completed", - "percent_completed" - ] - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at" - ], - "nullable": true - }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "color": { - "type": "string", - "nullable": true - } - }, - "required": [ - "name", - "color" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, + "additionalProperties": { "type": "string" }, - "email": { - "nullable": true, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } }, - "assigner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "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 + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true } + ], + "assignee": { + "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 }, - "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" + "assignees": [ + { + "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 + } ], - "nullable": true - }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 }, - "type": { - "type": "string", - "example": "User" + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "performed_via_github_app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "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", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "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", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, - "site_admin": { - "type": "boolean" + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "events": [ + "push", + "pull_request" + ] + }, + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}": { + "get": { + "summary": "Get an issue", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#get-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" }, - "user_view_type": { - "type": "string", - "example": "public" + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "requested_reviewer": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -307030,620 +316688,1736 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "requested_team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } + "email": { + "nullable": true, + "type": "string" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } }, - "dismissed_review": { - "title": "Issue Event Dismissed Review", - "type": "object", - "properties": { - "state": { - "type": "string" - }, - "review_id": { - "type": "integer" - }, - "dismissal_message": { - "type": "string", - "nullable": true - }, - "dismissal_commit_id": { - "type": "string", - "nullable": true - } + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } }, - "milestone": { - "title": "Issue Event Milestone", - "description": "Issue Event Milestone", - "type": "object", - "properties": { - "title": { - "type": "string" - } + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "title" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "project_card": { - "title": "Issue Event Project Card", - "description": "Issue Event Project Card", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "column_name": { - "type": "string" + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "previous_column_name": { - "type": "string" - } + "required": [ + "admin", + "pull", + "push" + ] }, - "required": [ - "url", - "id", - "project_url", - "project_id", - "column_name" - ] - }, - "rename": { - "title": "Issue Event Rename", - "description": "Issue Event Rename", - "type": "object", - "properties": { - "from": { - "type": "string" + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "to": { + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { "type": "string" } }, - "required": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "lock_reason": { - "type": "string", - "nullable": true + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" + } + } + } }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "email": { + "nullable": true, + "type": "string" }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "contents": { - "type": "string" + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "deployments": { - "type": "string" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "additionalProperties": { + "checks": { "type": "string" }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { "type": "string" } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" } }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at" - ] - } + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] }, "examples": { "default": { - "value": [ - { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -307662,176 +318436,119 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "issue": { - "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "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 - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "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 - }, - "assignees": [ - { - "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 - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR", - "state_reason": "completed" } - } - ] + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -307839,76 +318556,64 @@ "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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" } } } } } + }, + "304": { + "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "events" + "subcategory": "issues" } - } - }, - "/repos/{owner}/{repo}/issues/events/{event_id}": { - "get": { - "summary": "Get an issue event", - "description": "Gets a single event by the event id.", + }, + "patch": { + "summary": "Update an issue", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/get-event", + "operationId": "issues/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/events#get-an-issue-event" + "url": "https://docs.github.com/rest/issues/issues#update-an-issue" }, "parameters": [ { @@ -307930,7 +318635,8 @@ } }, { - "name": "event_id", + "name": "issue_number", + "description": "The number that identifies the issue.", "in": "path", "required": true, "schema": { @@ -307938,31 +318644,207 @@ } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "description": "The title of the issue.", + "nullable": true + }, + "body": { + "type": "string", + "description": "The contents of the issue.", + "nullable": true + }, + "assignee": { + "type": "string", + "nullable": true, + "description": "Username to assign to this issue. **This field is closing down.**" + }, + "state": { + "type": "string", + "description": "The open or closed state of the issue.", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "enum": [ + "completed", + "not_planned", + "duplicate", + "reopened" + ], + "nullable": true, + "description": "The reason for the state change. Ignored unless `state` is changed.", + "example": "not_planned" + }, + "milestone": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer", + "description": "The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped." + } + ], + "nullable": true + }, + "labels": { + "type": "array", + "description": "Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + } + } + ] + } + }, + "assignees": { + "type": "array", + "description": "Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.", + "nullable": true, + "example": "Epic" + } + } + }, + "examples": { + "default": { + "value": { + "title": "Found a bug", + "body": "I'm having a problem with this.", + "assignees": [ + "octocat" + ], + "milestone": 1, + "state": "open", + "labels": [ + "bug" + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Issue Event", - "description": "Issue Event", + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { - "type": "string", - "example": "MDEwOklzc3VlRXZlbnQx" + "type": "string" }, "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + "format": "uri" }, - "actor": { + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -308087,96 +318969,358 @@ ], "nullable": true }, - "event": { - "type": "string", - "example": "closed" - }, - "commit_id": { - "type": "string", - "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true - }, - "commit_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "example": 1 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "repository_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://github.com/octocat" }, - "labels_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "comments_url": { + "following_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", "type": "string", - "nullable": true, "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] + "open", + "closed" + ], + "default": "open" }, "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "description": "The title of the milestone.", + "example": "v1.0", "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "description": { "type": "string", + "example": "Tracking milestone for version 1.0", "nullable": true }, - "user": { + "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -308301,596 +319445,409 @@ ], "nullable": true }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } + "open_issues": { + "type": "integer", + "example": 4 }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", "nullable": true }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", "nullable": true }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 + "example": "mit" }, - "closed_issues": { - "type": "integer", - "example": 8 + "name": { + "type": "string", + "example": "MIT License" }, - "created_at": { + "url": { "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "updated_at": { + "spdx_id": { "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" + "nullable": true, + "example": "MIT" }, - "closed_at": { + "node_id": { "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true + "example": "MDc6TGljZW5zZW1pdA==" }, - "due_on": { + "html_url": { "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true + "format": "uri" } }, "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", + "key", + "name", "url", - "created_at", - "updated_at" + "spdx_id", + "node_id" ], "nullable": true }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { + "forks": { "type": "integer" }, - "pull_request": { + "permissions": { "type": "object", "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true + "admin": { + "type": "boolean" }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true + "pull": { + "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true + "triage": { + "type": "boolean" }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true + "push": { + "type": "boolean" }, - "url": { - "type": "string", - "format": "uri", - "nullable": true + "maintain": { + "type": "boolean" } }, "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "admin", + "pull", + "push" ] }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -309012,174 +319969,546 @@ "subscriptions_url", "type", "url" - ], + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true }, - "body_html": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "body_text": { + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { "type": "string" }, - "timeline_url": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", - "format": "uri" + "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)." }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", + "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", + "example": 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", + "example": "\"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", - "nullable": true, + "description": "The status of the code search index for this repository", "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" + "lexical_search_ok": { + "type": "boolean" }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "lexical_commit_sha": { + "type": "string" } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + } + } + }, + "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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -309303,957 +320632,813 @@ "url" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", - "description": "The status of the code search index for this repository", "properties": { - "lexical_search_ok": { - "type": "boolean" + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true }, - "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" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" }, - "checks": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" }, - "metadata": { - "type": "string" + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "contents": { - "type": "string" + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" }, - "deployments": { - "type": "string" + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" ] }, - "author_association": { - "title": "author_association", + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "example": "The description of the app.", + "nullable": true }, - "reactions": { - "title": "Reaction Rollup", + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" + "issues": { + "type": "string" }, - "heart": { - "type": "integer" + "checks": { + "type": "string" }, - "hooray": { - "type": "integer" + "metadata": { + "type": "string" }, - "eyes": { - "type": "integer" + "contents": { + "type": "string" }, - "rocket": { - "type": "integer" + "deployments": { + "type": "string" } }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } + "additionalProperties": { + "type": "string" }, - "required": [ - "total", - "completed", - "percent_completed" - ] + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", + "owner", + "name", + "description", + "external_url", + "html_url", "created_at", - "updated_at" - ], - "nullable": true + "updated_at", + "permissions", + "events" + ] }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", "type": "object", "properties": { - "name": { - "type": "string", - "nullable": true + "blocked_by": { + "type": "integer" }, - "color": { - "type": "string", - "nullable": true + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" } }, "required": [ - "name", - "color" + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + } + }, + "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" }, - "assignee": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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": "issues", + "subcategory": "issues" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + "post": { + "summary": "Add assignees to an issue", + "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", + "tags": [ + "issues" + ], + "operationId": "issues/add-assignees", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "type": "array", + "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "assignees": [ + "hubot", + "other_user" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -310378,7 +321563,52 @@ ], "nullable": true }, - "assigner": { + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -310503,132 +321733,426 @@ ], "nullable": true }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, - "email": { - "nullable": true, - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, - "login": { + "labels_url": { "type": "string", - "example": "octocat" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { "type": "integer", - "format": "int64", - "example": 1 + "example": 1002604 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, - "gravatar_id": { + "state": { + "description": "The state of the milestone.", + "example": "open", "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "enum": [ + "open", + "closed" + ], + "default": "open" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" }, - "html_url": { + "description": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "Tracking milestone for version 1.0", + "nullable": true }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "open_issues": { + "type": "integer", + "example": 4 }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "closed_issues": { + "type": "integer", + "example": 8 }, - "starred_url": { + "created_at": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "date-time", + "example": "2011-04-10T20:09:31Z" }, - "subscriptions_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, - "organizations_url": { + "closed_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true }, - "repos_url": { + "due_on": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "nullable": true }, - "received_events_url": { + "diff_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "nullable": true }, - "type": { + "html_url": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "nullable": true }, - "starred_at": { + "patch_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri", + "nullable": true }, - "user_view_type": { + "url": { "type": "string", - "example": "public" + "format": "uri", + "nullable": true } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "diff_url", "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "patch_url", "url" - ], + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", "nullable": true }, - "requested_reviewer": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -310753,39 +322277,151 @@ ], "nullable": true }, - "requested_team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": "object", + "nullable": true, "properties": { "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue type." }, "node_id": { - "type": "string" + "type": "string", + "description": "The node identifier of the issue type." }, "name": { - "type": "string" - }, - "slug": { - "type": "string" + "type": "string", + "description": "The name of the issue type." }, "description": { "type": "string", + "description": "The description of the issue type.", "nullable": true }, - "privacy": { - "type": "string" + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, - "notification_setting": { - "type": "string" + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" }, - "permission": { - "type": "string" + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" }, "permissions": { "type": "object", "properties": { + "admin": { + "type": "boolean" + }, "pull": { "type": "boolean" }, @@ -310797,243 +322433,649 @@ }, "maintain": { "type": "boolean" - }, - "admin": { - "type": "boolean" } }, "required": [ + "admin", "pull", - "triage", - "push", - "maintain", - "admin" + "push" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { - "description": "Unique identifier of the team", "type": "integer", + "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VGVhbTE=" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { - "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" + "example": "https://api.github.com/users/octocat" }, - "members_url": { + "html_url": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "format": "uri", + "example": "https://github.com/octocat" }, - "name": { - "description": "Name of the team", + "followers_url": { "type": "string", - "example": "Justice League" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "description": { - "description": "Description of the team", + "following_url": { "type": "string", - "nullable": true, - "example": "A great team." + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "permission": { - "description": "Permission that the team will have for its repositories", + "gists_url": { "type": "string", - "example": "admin" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "privacy": { - "description": "The level of privacy this team should have", + "starred_url": { "type": "string", - "example": "closed" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "notification_setting": { - "description": "The notification setting the team has set", + "subscriptions_url": { "type": "string", - "example": "notifications_enabled" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "example": "https://api.github.com/users/octocat/orgs" }, - "repositories_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "example": "https://api.github.com/users/octocat/repos" }, - "slug": { + "events_url": { "type": "string", - "example": "justice-league" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - "dismissed_review": { - "title": "Issue Event Dismissed Review", - "type": "object", - "properties": { - "state": { + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "review_id": { - "type": "integer" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true }, - "dismissal_message": { + "created_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", "nullable": true }, - "dismissal_commit_id": { + "updated_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", "nullable": true - } - }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] - }, - "milestone": { - "title": "Issue Event Milestone", - "description": "Issue Event Milestone", - "type": "object", - "properties": { - "title": { + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { "type": "string" - } - }, - "required": [ - "title" - ] - }, - "project_card": { - "title": "Issue Event Project Card", - "description": "Issue Event Project Card", - "type": "object", - "properties": { - "url": { + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", - "format": "uri" + "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)." }, - "id": { - "type": "integer" + "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." }, - "project_url": { + "merge_commit_title": { "type": "string", - "format": "uri" + "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)." }, - "project_id": { + "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", + "example": 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" }, - "column_name": { - "type": "string" + "watchers": { + "type": "integer" }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "project_url", - "project_id", - "column_name" - ] - }, - "rename": { - "title": "Issue Event Rename", - "description": "Issue Event Rename", - "type": "object", - "properties": { - "from": { + "master_branch": { "type": "string" }, - "to": { - "type": "string" + "starred_at": { + "type": "string", + "example": "\"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": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "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" ] }, - "lock_reason": { - "type": "string", - "nullable": true - }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -311323,45 +323365,176 @@ "type": "string" } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { "type": "integer" } }, "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at" + "user", + "author_association", + "created_at", + "updated_at" ] }, "examples": { "default": { "value": { "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -311381,24 +323554,39 @@ "type": "User", "site_admin": false }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "issue": { + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { + "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 + }, + "assignees": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -311417,19 +323605,19 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -311449,198 +323637,47 @@ "type": "User", "site_admin": false }, - "assignees": [ - { - "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 - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "performed_via_github_app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "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", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "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" + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -311652,21 +323689,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "events" + "subcategory": "assignees" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}": { - "get": { - "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + }, + "delete": { + "summary": "Remove assignees from an issue", + "description": "Removes one or more assignees from an issue.", "tags": [ "issues" ], - "operationId": "issues/get", + "operationId": "issues/remove-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#get-an-issue" + "url": "https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue" }, "parameters": [ { @@ -311697,6 +323732,34 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "type": "array", + "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "assignees": [ + "hubot", + "other_user" + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", @@ -313803,6 +325866,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -313993,9 +326080,71 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + "get": { + "summary": "Check if a user can be assigned to a issue", + "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", + "tags": [ + "issues" + ], + "operationId": "issues/check-user-can-be-assigned-to-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "301": { - "description": "Moved permanently", + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "assignee", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if `assignee` can be assigned to `issue_number`" + }, + "404": { + "description": "Response if `assignee` can not be assigned to `issue_number`", "content": { "application/json": { "schema": { @@ -314019,6 +326168,701 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "get": { + "summary": "List issue comments", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-comments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#list-issue-comments" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "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": { + "type": "array", + "items": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "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 + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } }, "404": { "description": "Resource not found", @@ -314071,28 +326915,25 @@ } } } - }, - "304": { - "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "comments" } }, - "patch": { - "summary": "Update an issue", - "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "post": { + "summary": "Create an issue comment", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/update", + "operationId": "issues/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/rest/issues/comments#create-an-issue-comment" }, "parameters": [ { @@ -314124,124 +326965,25 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "The title of the issue.", - "nullable": true - }, "body": { "type": "string", - "description": "The contents of the issue.", - "nullable": true - }, - "assignee": { - "type": "string", - "nullable": true, - "description": "Username to assign to this issue. **This field is closing down.**" - }, - "state": { - "type": "string", - "description": "The open or closed state of the issue.", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": "string", - "enum": [ - "completed", - "not_planned", - "duplicate", - "reopened" - ], - "nullable": true, - "description": "The reason for the state change. Ignored unless `state` is changed.", - "example": "not_planned" - }, - "milestone": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped." - } - ], - "nullable": true - }, - "labels": { - "type": "array", - "description": "Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - } - } - } - ] - } - }, - "assignees": { - "type": "array", - "description": "Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.", - "nullable": true, - "example": "Epic" + "description": "The contents of the comment." } - } + }, + "required": [ + "body" + ] }, "examples": { "default": { "value": { - "title": "Found a bug", - "body": "I'm having a problem with this.", - "assignees": [ - "octocat" - ], - "milestone": 1, - "state": "open", - "labels": [ - "bug" - ] + "body": "Me too" } } } @@ -314249,16 +326991,18 @@ } }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the issue comment", + "example": 42, "type": "integer", "format": "int64" }, @@ -314266,62 +327010,25 @@ "type": "string" }, "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", "format": "uri" }, - "labels_url": { + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", "type": "string" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", + "body_text": { "type": "string" }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", - "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] - }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "body_html": { "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "html_url": { "type": "string", - "nullable": true + "format": "uri" }, "user": { "title": "Simple User", @@ -314426,201 +327133,939 @@ "example": "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" - ], - "nullable": true - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "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 + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "schema": { + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + "get": { + "summary": "List dependencies an issue is blocked by", + "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": { + "type": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, "type": "string" }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { + "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -314742,64 +328187,12 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { + "assignees": { + "type": "array", + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -314921,1533 +328314,1686 @@ "subscriptions_url", "type", "url" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true + ] }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } + "nullable": true }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "locked": { + "type": "boolean" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } + "active_lock_reason": { + "type": "string", + "nullable": true }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "html_url": { + "type": "string", + "format": "uri", + "nullable": true }, - "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } }, - "topics": { - "type": "array", - "items": { + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "lexical_commit_sha": { + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { "type": "string" } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "required": [ + "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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user_view_type": { - "type": "string", - "example": "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" + ] }, - "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "contents": { + "additionalProperties": { "type": "string" }, - "deployments": { - "type": "string" + "example": { + "issues": "read", + "deployments": "write" } }, - "additionalProperties": { - "type": "string" + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } }, - "example": { - "issues": "read", - "deployments": "write" + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } }, - "rocket": { - "type": "integer" - } + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at" - ] + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } }, "examples": { "default": { - "value": { - "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "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 - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "login": "octocat", + "value": [ + { "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 - }, - "assignees": [ - { + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -316466,19 +330012,19 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -316498,165 +330044,110 @@ "type": "User", "site_admin": false }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "closed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - } - } - } - }, - "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" + "assignees": [ + { + "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 + } ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } + ] } } } - } - }, - "403": { - "description": "Forbidden", - "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" } } } @@ -316744,21 +330235,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "issue-dependencies" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + }, "post": { - "summary": "Add assignees to an issue", - "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", + "summary": "Add a dependency an issue is blocked by", + "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/add-assignees", + "operationId": "issues/add-blocked-by-dependency", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue" + "url": "https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -316790,28 +330279,25 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "assignees": { - "type": "array", - "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "items": { - "type": "string" - } + "issue_id": { + "type": "integer", + "description": "The id of the issue that blocks the current issue" } - } + }, + "required": [ + "issue_id" + ] }, "examples": { "default": { "value": { - "assignees": [ - "hubot", - "other_user" - ] + "issue_id": 1 } } } @@ -318924,6 +332410,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -319037,78 +332547,259 @@ "type": "User", "site_admin": false } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "closed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" } } } @@ -319117,22 +332808,25 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "assignees" + "subcategory": "issue-dependencies" } - }, + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { "delete": { - "summary": "Remove assignees from an issue", - "description": "Removes one or more assignees from an issue.", + "summary": "Remove dependency an issue is blocked by", + "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/remove-assignees", + "operationId": "issues/remove-dependency-blocked-by", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue" + "url": "https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -319161,36 +332855,17 @@ "schema": { "type": "integer" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "assignees": { - "type": "array", - "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "assignees": [ - "hubot", - "other_user" - ] - } - } - } + }, + { + "name": "issue_id", + "in": "path", + "description": "The id of the blocking issue to remove as a dependency", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { "200": { "description": "Response", @@ -321297,6 +334972,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -321487,71 +335186,173 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "assignees" - } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { - "get": { - "summary": "Check if a user can be assigned to a issue", - "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", - "tags": [ - "issues" - ], - "operationId": "issues/check-user-can-be-assigned-to-issue", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" + }, + "301": { + "description": "Moved permanently", + "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": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } } }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" + "401": { + "description": "Requires authentication", + "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": "assignee", - "in": "path", - "required": true, - "schema": { - "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" + } + } + } + } } - } - ], - "responses": { - "204": { - "description": "Response if `assignee` can be assigned to `issue_number`" }, "404": { - "description": "Response if `assignee` can not be assigned to `issue_number`", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -321578,24 +335379,25 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "assignees" + "subcategory": "issue-dependencies" } } }, - "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { "get": { - "summary": "List issue comments", - "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "summary": "List dependencies an issue is blocking", + "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/list-comments", + "operationId": "issues/list-dependencies-blocking", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#list-issue-comments" + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" }, "parameters": [ { @@ -321625,16 +335427,6 @@ "type": "integer" } }, - { - "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, { "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).\"", @@ -321662,13 +335454,11 @@ "schema": { "type": "array", "items": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the issue comment", - "example": 42, "type": "integer", "format": "int64" }, @@ -321676,26 +335466,63 @@ "type": "string" }, "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" + "repository_url": { + "type": "string", + "format": "uri" }, - "body_text": { + "labels_url": { "type": "string" }, - "body_html": { - "type": "string" + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, "user": { "title": "Simple User", "description": "A GitHub user.", @@ -321821,34 +335648,1517 @@ ], "nullable": true }, - "created_at": { + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { "type": "string", "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "format": "date-time" }, - "issue_url": { + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { "type": "string", "format": "uri" }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" ] }, "performed_via_github_app": { @@ -322160,6 +337470,22 @@ "events" ] }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, "reactions": { "title": "Reaction Rollup", "type": "object", @@ -322208,16 +337534,72 @@ "eyes", "rocket" ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", - "html_url", - "issue_url", - "author_association", - "user", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", + "user", + "author_association", "created_at", "updated_at" ] @@ -322228,10 +337610,17 @@ "value": [ { "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, @@ -322252,765 +337641,147 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "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": "issues", - "subcategory": "comments" - } - }, - "post": { - "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", - "tags": [ - "issues" - ], - "operationId": "issues/create-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#create-an-issue-comment" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "The contents of the comment." - } - }, - "required": [ - "body" - ] - }, - "examples": { - "default": { - "value": { - "body": "Me too" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true } + ], + "assignee": { + "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 }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" + "assignees": [ + { + "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 } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, - "eyes": { - "type": "integer" + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "user": { - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - } + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + ] } } } }, "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, - "403": { - "description": "Forbidden", + "301": { + "description": "Moved permanently", "content": { "application/json": { "schema": { @@ -323035,8 +337806,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -323061,77 +337832,8 @@ } } }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -323158,11 +337860,10 @@ } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "comments" + "subcategory": "issue-dependencies" } } }, @@ -336809,6 +351510,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -339271,6 +353996,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -341709,6 +356458,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -344246,6 +359019,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -354790,6 +369587,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -453320,6 +468141,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "type": "string" }, @@ -497419,6 +512264,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -527096,6 +541965,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -530077,6 +544970,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -533060,6 +547977,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -542409,6 +557350,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -545392,6 +560357,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -707729,6 +722718,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -711470,6 +726483,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -715235,6 +730272,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -719406,6 +734467,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -721537,6 +736622,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -725945,6 +741054,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -728076,6 +743209,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -732484,6 +747641,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -735344,6 +750525,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -739023,6 +754228,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -741883,6 +757112,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -744706,6 +759959,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -747596,6 +762873,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -750678,6 +765979,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -753578,6 +768903,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -756651,6 +772000,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -759575,6 +774948,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -762525,6 +777922,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -765401,6 +780822,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -768355,6 +783800,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -770308,6 +785777,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -773186,6 +788679,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -776089,6 +791606,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -778859,6 +794400,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -780828,6 +796393,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -783713,6 +799302,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -786756,6 +802369,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -789641,6 +805278,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -792589,6 +808250,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -795444,6 +811129,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -798328,6 +814037,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -885636,6 +901369,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -886402,6 +902330,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -887168,6 +903291,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -887987,6 +904305,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -892520,6 +909033,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1147289,6 +1163997,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1150149,6 +1166881,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1153825,6 +1170581,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1156685,6 +1173465,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1160361,6 +1177165,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1163221,6 +1180049,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1166897,6 +1183749,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1169757,6 +1186633,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 09d5733167..7797a67865 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -99,6 +99,8 @@ tags: description: Revoke compromised or leaked GitHub credentials. - name: campaigns description: Endpoints to manage campaigns via the REST API. +- name: projects + description: Endpoints to manage Projects using the REST API. servers: - url: https://api.github.com externalDocs: @@ -851,7 +853,7 @@ paths: - subscriptions_url - type - url - type: &281 + type: &286 type: string description: The type of credit the user is receiving. enum: @@ -984,7 +986,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &101 + schema: &104 title: Validation Error Simple description: Validation Error Simple type: object @@ -1017,7 +1019,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &604 + - &614 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1573,7 +1575,7 @@ paths: schema: type: integer default: 30 - - &174 + - &177 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1589,7 +1591,7 @@ paths: application/json: schema: type: array - items: &175 + items: &178 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1669,7 +1671,7 @@ paths: - installation_id - repository_id examples: - default: &176 + default: &179 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1728,7 +1730,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &100 + schema: &103 title: Validation Error description: Validation Error type: object @@ -1797,7 +1799,7 @@ paths: description: Response content: application/json: - schema: &177 + schema: &180 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1911,7 +1913,7 @@ paths: - request - response examples: - default: &178 + default: &181 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2841,7 +2843,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &239 + properties: &242 id: description: Unique identifier of the repository example: 42 @@ -3279,7 +3281,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &240 + required: &243 - archive_url - assignees_url - blobs_url @@ -5066,7 +5068,7 @@ paths: responses: '202': *39 '422': *7 - '500': &97 + '500': &100 description: Internal Error content: application/json: @@ -7391,7 +7393,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &145 + code_scanning_options: &148 type: object description: Security Configuration feature options for code scanning nullable: true @@ -7585,7 +7587,7 @@ paths: description: Response content: application/json: - schema: &147 + schema: &150 type: array description: A list of default code security configurations items: @@ -7601,7 +7603,7 @@ paths: default configuration: *43 examples: - default: &148 + default: &151 value: - default_for_new_repos: public configuration: @@ -7932,7 +7934,7 @@ paths: - *42 - *45 responses: - '204': &149 + '204': &152 description: A header with no content is returned. '400': *14 '403': *29 @@ -8059,7 +8061,7 @@ paths: default: value: default_for_new_repos: all - configuration: &146 + configuration: &149 value: id: 1325 target_type: organization @@ -8144,7 +8146,7 @@ paths: application/json: schema: type: array - items: &150 + items: &153 type: object description: Repositories associated with a code security configuration and attachment status @@ -8166,7 +8168,7 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: &94 + properties: &98 id: type: integer format: int64 @@ -8393,7 +8395,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &95 + required: &99 - archive_url - assignees_url - blobs_url @@ -8445,7 +8447,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &151 + repository: &154 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8539,7 +8541,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *42 - - &156 + - &159 name: state in: query description: |- @@ -8548,7 +8550,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &157 + - &160 name: severity in: query description: |- @@ -8557,7 +8559,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &158 + - &161 name: ecosystem in: query description: |- @@ -8566,14 +8568,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &159 + - &162 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &160 + - &163 name: epss_percentage in: query description: |- @@ -8585,7 +8587,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &161 + - &164 name: has in: query description: |- @@ -8599,7 +8601,7 @@ paths: type: string enum: - patch - - &162 + - &165 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8609,7 +8611,7 @@ paths: enum: - development - runtime - - &163 + - &166 name: sort in: query description: |- @@ -8627,7 +8629,7 @@ paths: - *48 - *40 - *41 - - &164 + - &167 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -8640,7 +8642,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &165 + - &168 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -8660,7 +8662,7 @@ paths: application/json: schema: type: array - items: &166 + items: &169 type: object description: A Dependabot alert. properties: @@ -8726,7 +8728,7 @@ paths: - unknown - direct - transitive - security_advisory: &454 + security_advisory: &464 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8945,13 +8947,13 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &139 + updated_at: &142 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &141 + dismissed_at: &144 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -8981,14 +8983,14 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &140 + fixed_at: &143 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &455 + auto_dismissed_at: &465 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9014,7 +9016,7 @@ paths: - repository additionalProperties: false examples: - default: &167 + default: &170 value: - number: 2 state: dismissed @@ -9361,7 +9363,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *42 - - &271 + - &274 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -9372,7 +9374,7 @@ paths: enum: - open - resolved - - &272 + - &275 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -9382,7 +9384,7 @@ paths: required: false schema: type: string - - &273 + - &276 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -9391,7 +9393,7 @@ paths: required: false schema: type: string - - &274 + - &277 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -9407,7 +9409,7 @@ paths: - *17 - *40 - *41 - - &275 + - &278 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -9416,7 +9418,7 @@ paths: required: false schema: type: string - - &276 + - &279 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -9425,7 +9427,7 @@ paths: schema: type: boolean default: false - - &277 + - &280 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -9434,7 +9436,7 @@ paths: schema: type: boolean default: false - - &278 + - &281 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -9450,7 +9452,7 @@ paths: application/json: schema: type: array - items: &279 + items: &282 type: object properties: number: *54 @@ -9469,14 +9471,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &582 + state: &592 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &583 + resolution: &593 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -9583,8 +9585,8 @@ paths: pull request. ' - oneOf: &584 - - &586 + oneOf: &594 + - &596 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -9636,7 +9638,7 @@ paths: - blob_url - commit_sha - commit_url - - &587 + - &597 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -9691,7 +9693,7 @@ paths: - page_url - commit_sha - commit_url - - &588 + - &598 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -9705,7 +9707,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &589 + - &599 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -9719,7 +9721,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &590 + - &600 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -9733,7 +9735,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &591 + - &601 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -9747,7 +9749,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &592 + - &602 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -9761,7 +9763,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &593 + - &603 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -9775,7 +9777,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &594 + - &604 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -9789,7 +9791,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &595 + - &605 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -9803,7 +9805,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &596 + - &606 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -9817,7 +9819,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &597 + - &607 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -9831,7 +9833,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &598 + - &608 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -9851,7 +9853,7 @@ paths: description: A boolean value representing whether or not the token in the alert was detected in more than one location. examples: - default: &280 + default: &283 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -10203,7 +10205,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &503 + properties: &513 id: type: integer format: int64 @@ -10315,7 +10317,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &439 + properties: &449 url: type: string format: uri @@ -10385,7 +10387,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &440 + required: &450 - closed_issues - creator - description @@ -10464,7 +10466,7 @@ paths: timeline_url: type: string format: uri - type: &196 + type: &199 title: Issue Type description: The type of issue. type: object @@ -10575,7 +10577,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &616 + sub_issues_summary: &626 title: Sub-issues Summary type: object properties: @@ -10589,7 +10591,24 @@ paths: - total - completed - percent_completed - required: &504 + issue_dependencies_summary: &627 + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + required: &514 - assignee - closed_at - comments @@ -10611,7 +10630,7 @@ paths: - author_association - created_at - updated_at - comment: &501 + comment: &511 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11178,7 +11197,7 @@ paths: url: type: string format: uri - user: &628 + user: &639 title: Public User description: Public User type: object @@ -13048,7 +13067,7 @@ paths: - closed - all default: open - - &199 + - &202 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13099,7 +13118,7 @@ paths: type: array items: *77 examples: - default: &200 + default: &203 value: - id: 1 node_id: MDU6SXNzdWUx @@ -14484,14 +14503,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &304 + - &309 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &305 + - &310 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -14562,7 +14581,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &316 + '301': &321 description: Moved permanently content: application/json: @@ -14584,7 +14603,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &533 + - &543 name: all description: If `true`, show notifications marked as read. in: query @@ -14592,7 +14611,7 @@ paths: schema: type: boolean default: false - - &534 + - &544 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14602,7 +14621,7 @@ paths: type: boolean default: false - *67 - - &535 + - &545 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -14634,11 +14653,11 @@ paths: properties: id: type: string - repository: &122 + repository: &125 title: Minimal Repository description: Minimal Repository type: object - properties: &169 + properties: &172 id: type: integer format: int64 @@ -14914,7 +14933,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &241 + security_and_analysis: &244 nullable: true type: object properties: @@ -14988,7 +15007,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &170 + required: &173 - archive_url - assignees_url - blobs_url @@ -15076,7 +15095,7 @@ paths: - url - subscription_url examples: - default: &536 + default: &546 value: - id: '1' repository: @@ -15618,11 +15637,11 @@ paths: application/json: schema: type: array - items: &206 + items: &209 title: Organization Simple description: A GitHub organization. type: object - properties: &153 + properties: &156 login: type: string example: github @@ -15663,7 +15682,7 @@ paths: type: string example: A great organization nullable: true - required: &154 + required: &157 - login - url - id @@ -15677,7 +15696,7 @@ paths: - avatar_url - description examples: - default: &646 + default: &656 value: - login: github id: 1 @@ -15702,6 +15721,643 @@ 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: + - &94 + 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: &336 + 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': *29 + '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: + - *94 + requestBody: + required: true + content: + application/json: + schema: &337 + 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': *29 + '404': *6 + '409': *47 + '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: + - *94 + responses: + '200': + description: Response + content: + application/json: + schema: &95 + 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: &338 + 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: + - *94 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *95 + 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: + - *94 + responses: + '200': + description: Response + content: + application/json: + schema: &339 + 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: &96 + 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': *29 + '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: + - *94 + requestBody: + required: true + content: + application/json: + schema: &340 + 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: *96 + 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: + - *94 + 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': *29 + '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: + - *94 + 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': *29 + '404': *6 + '409': *47 + '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: + - *94 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: *60 + examples: + default: &115 + 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': *29 + '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: + - *94 + 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': *29 + '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: + - *94 + - &97 + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + responses: + '204': + description: No content + '403': *29 + '404': *6 + '409': *47 + '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: + - *94 + - *97 + responses: + '204': + description: No content + '403': *29 + '404': *6 + '409': *47 + '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 @@ -15717,13 +16373,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - &96 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string + - *94 - name: page in: query description: The page number of results to fetch. @@ -15767,8 +16417,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *94 - required: *95 + properties: *98 + required: *99 nullable: true additionalProperties: false examples: @@ -15874,7 +16524,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -15940,7 +16590,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *96 + - *94 requestBody: required: true content: @@ -15987,8 +16637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - *96 - - &672 + - *94 + - &682 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, @@ -15997,7 +16647,7 @@ paths: required: false schema: type: integer - - &673 + - &683 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 @@ -16006,7 +16656,7 @@ paths: required: false schema: type: integer - - &674 + - &684 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 @@ -16015,7 +16665,7 @@ paths: required: false schema: type: integer - - &675 + - &685 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 @@ -16098,7 +16748,7 @@ paths: repositoryName: github/example '400': *14 '403': *29 - '500': *97 + '500': *100 '503': *65 x-github: githubCloudOnly: false @@ -16125,13 +16775,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &98 + schema: &101 title: Organization Full description: Organization Full type: object @@ -16450,7 +17100,7 @@ paths: - updated_at - archived_at examples: - default-response: &99 + default-response: &102 value: login: github id: 1 @@ -16550,7 +17200,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *96 + - *94 requestBody: required: false content: @@ -16766,17 +17416,17 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: *99 + default: *102 '422': description: Validation failed content: application/json: schema: oneOf: - - *100 - - *101 + - *103 + - *104 '409': *47 x-github: githubCloudOnly: false @@ -16800,7 +17450,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *96 + - *94 responses: '202': *39 '404': *6 @@ -16825,7 +17475,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -16872,7 +17522,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -16890,7 +17540,7 @@ paths: type: integer repository_cache_usages: type: array - items: &321 + items: &326 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -16945,7 +17595,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -16963,7 +17613,7 @@ paths: type: integer runners: type: array - items: &102 + items: &105 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -17012,7 +17662,7 @@ paths: - display_name - source nullable: true - machine_size_details: &105 + machine_size_details: &108 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -17104,7 +17754,7 @@ paths: - public_ip_enabled - platform examples: - default: &121 + default: &124 value: total_count: 2 runners: @@ -17164,7 +17814,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -17231,9 +17881,9 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: &106 + default: &109 value: id: 5 name: My hosted ubuntu runner @@ -17272,7 +17922,7 @@ paths: 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: - - *96 + - *94 responses: '200': description: Response @@ -17288,7 +17938,7 @@ paths: type: integer images: type: array - items: &103 + items: &106 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -17324,7 +17974,7 @@ paths: - display_name - source examples: - default: &104 + default: &107 value: id: ubuntu-20.04 platform: linux-x64 @@ -17348,7 +17998,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -17364,9 +18014,9 @@ paths: type: integer images: type: array - items: *103 + items: *106 examples: - default: *104 + default: *107 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17383,7 +18033,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -17436,7 +18086,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -17452,7 +18102,7 @@ paths: type: integer machine_specs: type: array - items: *105 + items: *108 examples: default: value: @@ -17477,7 +18127,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -17521,8 +18171,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *96 - - &107 + - *94 + - &110 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -17534,9 +18184,9 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *106 + default: *109 headers: Link: *58 x-github: @@ -17556,8 +18206,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *96 - - *107 + - *94 + - *110 requestBody: required: true content: @@ -17595,9 +18245,9 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *106 + default: *109 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17613,16 +18263,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *96 - - *107 + - *94 + - *110 responses: '202': description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *106 + default: *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -17642,13 +18292,13 @@ paths: 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: - - *96 + - *94 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &108 + schema: &111 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -17662,7 +18312,7 @@ paths: required: - include_claim_keys examples: - default: &109 + default: &112 value: include_claim_keys: - repo @@ -17684,20 +18334,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: application/json: - schema: *108 + schema: *111 examples: - default: *109 + default: *112 responses: '201': description: Empty response content: application/json: - schema: &131 + schema: &134 title: Empty Object description: An object without any properties. type: object @@ -17727,7 +18377,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -17736,7 +18386,7 @@ paths: schema: type: object properties: - enabled_repositories: &110 + enabled_repositories: &113 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -17749,7 +18399,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: &111 + allowed_actions: &114 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -17757,7 +18407,7 @@ paths: - all - local_only - selected - selected_actions_url: &327 + selected_actions_url: &332 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` @@ -17788,7 +18438,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *96 + - *94 responses: '204': description: Response @@ -17799,8 +18449,8 @@ paths: schema: type: object properties: - enabled_repositories: *110 - allowed_actions: *111 + enabled_repositories: *113 + allowed_actions: *114 required: - enabled_repositories examples: @@ -17827,7 +18477,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -17847,127 +18497,7 @@ paths: type: array items: *60 examples: - default: &640 - 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 + default: *115 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17987,7 +18517,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *96 + - *94 responses: '204': description: Response @@ -18031,14 +18561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *96 - - &112 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer + - *94 + - *97 responses: '204': description: Response @@ -18060,8 +18584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *96 - - *112 + - *94 + - *97 responses: '204': description: Response @@ -18084,13 +18608,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &113 + schema: &116 type: object properties: github_owned_allowed: @@ -18112,7 +18636,7 @@ paths: items: type: string examples: - default: &114 + default: &117 value: github_owned_allowed: true verified_allowed: false @@ -18137,7 +18661,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *96 + - *94 responses: '204': description: Response @@ -18145,9 +18669,9 @@ paths: required: false content: application/json: - schema: *113 + schema: *116 examples: - selected_actions: *114 + selected_actions: *117 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18169,23 +18693,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &331 + schema: &341 type: object properties: - default_workflow_permissions: &115 + default_workflow_permissions: &118 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &116 + can_approve_pull_request_reviews: &119 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -18193,7 +18717,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &117 + default: &120 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -18218,7 +18742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *96 + - *94 responses: '204': description: Success response @@ -18226,13 +18750,13 @@ paths: required: false content: application/json: - schema: &332 + schema: &342 type: object properties: - default_workflow_permissions: *115 - can_approve_pull_request_reviews: *116 + default_workflow_permissions: *118 + can_approve_pull_request_reviews: *119 examples: - default: *117 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18252,7 +18776,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *96 + - *94 - *17 - *19 - name: visible_to_repository @@ -18277,7 +18801,7 @@ paths: type: number runner_groups: type: array - items: &118 + items: &121 type: object properties: id: @@ -18393,7 +18917,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -18465,9 +18989,9 @@ paths: description: Response content: application/json: - schema: *118 + schema: *121 examples: - default: &120 + default: &123 value: id: 2 name: octo-runner-group @@ -18502,8 +19026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *96 - - &119 + - *94 + - &122 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -18515,7 +19039,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *121 examples: default: value: @@ -18551,8 +19075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *96 - - *119 + - *94 + - *122 requestBody: required: true content: @@ -18606,9 +19130,9 @@ paths: description: Response content: application/json: - schema: *118 + schema: *121 examples: - default: *120 + default: *123 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18627,8 +19151,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *96 - - *119 + - *94 + - *122 responses: '204': description: Response @@ -18651,8 +19175,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *96 - - *119 + - *94 + - *122 - *17 - *19 responses: @@ -18670,9 +19194,9 @@ paths: type: number runners: type: array - items: *102 + items: *105 examples: - default: *121 + default: *124 headers: Link: *58 x-github: @@ -18694,8 +19218,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *96 - - *119 + - *94 + - *122 - *19 - *17 responses: @@ -18713,9 +19237,9 @@ paths: type: number repositories: type: array - items: *122 + items: *125 examples: - default: &631 + default: &642 value: total_count: 1 repositories: @@ -18967,8 +19491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *96 - - *119 + - *94 + - *122 requestBody: required: true content: @@ -19012,9 +19536,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *96 - - *119 - - *112 + - *94 + - *122 + - *97 responses: '204': description: Response @@ -19036,9 +19560,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *96 - - *119 - - *112 + - *94 + - *122 + - *97 responses: '204': description: Response @@ -19061,8 +19585,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *96 - - *119 + - *94 + - *122 - *17 - *19 responses: @@ -19080,7 +19604,7 @@ paths: type: number runners: type: array - items: &124 + items: &127 title: Self hosted runners description: A self hosted runner type: object @@ -19109,7 +19633,7 @@ paths: type: boolean labels: type: array - items: &127 + items: &130 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -19139,7 +19663,7 @@ paths: - busy - labels examples: - default: &125 + default: &128 value: total_count: 2 runners: @@ -19198,8 +19722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *96 - - *119 + - *94 + - *122 requestBody: required: true content: @@ -19243,9 +19767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *96 - - *119 - - &123 + - *94 + - *122 + - &126 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -19273,9 +19797,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *96 - - *119 - - *123 + - *94 + - *122 + - *126 responses: '204': description: Response @@ -19305,7 +19829,7 @@ paths: in: query schema: type: string - - *96 + - *94 - *17 - *19 responses: @@ -19323,9 +19847,9 @@ paths: type: integer runners: type: array - items: *124 + items: *127 examples: - default: *125 + default: *128 headers: Link: *58 x-github: @@ -19349,7 +19873,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -19357,7 +19881,7 @@ paths: application/json: schema: type: array - items: &333 + items: &343 title: Runner Application description: Runner Application type: object @@ -19382,7 +19906,7 @@ paths: - download_url - filename examples: - default: &334 + default: &344 value: - os: osx architecture: x64 @@ -19425,7 +19949,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -19468,7 +19992,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &335 + '201': &345 description: Response content: application/json: @@ -19478,7 +20002,7 @@ paths: - runner - encoded_jit_config properties: - runner: *124 + runner: *127 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -19535,13 +20059,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *96 + - *94 responses: '201': description: Response content: application/json: - schema: &126 + schema: &129 title: Authentication Token description: Authentication Token type: object @@ -19579,7 +20103,7 @@ paths: - token - expires_at examples: - default: &336 + default: &346 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -19610,15 +20134,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *96 + - *94 responses: '201': description: Response content: application/json: - schema: *126 + schema: *129 examples: - default: &337 + default: &347 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -19643,16 +20167,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 + - *94 + - *126 responses: '200': description: Response content: application/json: - schema: *124 + schema: *127 examples: - default: &338 + default: &348 value: id: 23 name: MBP @@ -19693,8 +20217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *96 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -19720,10 +20244,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 + - *94 + - *126 responses: - '200': &128 + '200': &131 description: Response content: application/json: @@ -19737,7 +20261,7 @@ paths: type: integer labels: type: array - items: *127 + items: *130 examples: default: value: @@ -19776,8 +20300,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 + - *94 + - *126 requestBody: required: true content: @@ -19801,7 +20325,7 @@ paths: - gpu - accelerated responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -19825,8 +20349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 + - *94 + - *126 requestBody: required: true content: @@ -19851,7 +20375,7 @@ paths: - gpu - accelerated responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -19875,10 +20399,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 + - *94 + - *126 responses: - '200': &339 + '200': &349 description: Response content: application/json: @@ -19892,7 +20416,7 @@ paths: type: integer labels: type: array - items: *127 + items: *130 examples: default: value: @@ -19933,9 +20457,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 - - &340 + - *94 + - *126 + - &350 name: name description: The name of a self-hosted runner's custom label. in: path @@ -19943,7 +20467,7 @@ paths: schema: type: string responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -19968,7 +20492,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *96 + - *94 - *17 - *19 responses: @@ -19986,7 +20510,7 @@ paths: type: integer secrets: type: array - items: &129 + items: &132 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -20059,13 +20583,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &352 + schema: &362 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -20094,7 +20618,7 @@ paths: - key_id - key examples: - default: &353 + default: &363 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -20119,8 +20643,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *96 - - &130 + - *94 + - &133 name: secret_name description: The name of the secret. in: path @@ -20132,7 +20656,7 @@ paths: description: Response content: application/json: - schema: *129 + schema: *132 examples: default: value: @@ -20162,8 +20686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -20220,7 +20744,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -20246,8 +20770,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 responses: '204': description: Response @@ -20273,8 +20797,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - *19 - *17 responses: @@ -20292,9 +20816,9 @@ paths: type: integer repositories: type: array - items: *122 + items: *125 examples: - default: &134 + default: &137 value: total_count: 1 repositories: @@ -20386,8 +20910,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -20439,8 +20963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -20473,8 +20997,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -20506,8 +21030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *96 - - &326 + - *94 + - &331 name: per_page description: The number of results per page (max 30). 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)." @@ -20531,7 +21055,7 @@ paths: type: integer variables: type: array - items: &132 + items: &135 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -20616,7 +21140,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *96 + - *94 requestBody: required: true content: @@ -20664,7 +21188,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -20689,8 +21213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *96 - - &133 + - *94 + - &136 name: name description: The name of the variable. in: path @@ -20702,7 +21226,7 @@ paths: description: Response content: application/json: - schema: *132 + schema: *135 examples: default: value: @@ -20732,8 +21256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 requestBody: required: true content: @@ -20795,8 +21319,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 responses: '204': description: Response @@ -20822,8 +21346,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 - *19 - *17 responses: @@ -20841,9 +21365,9 @@ paths: type: integer repositories: type: array - items: *122 + items: *125 examples: - default: *134 + default: *137 '409': description: Response when the visibility of the variable is not set to `selected` @@ -20869,8 +21393,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 requestBody: required: true content: @@ -20919,8 +21443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 - name: repository_id in: path required: true @@ -20954,8 +21478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 - name: repository_id in: path required: true @@ -20991,7 +21515,7 @@ paths: - *17 - *40 - *41 - - *96 + - *94 requestBody: required: true content: @@ -21014,12 +21538,12 @@ paths: required: - subject_digests examples: - default: &661 + default: &671 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &662 + withPredicateType: &672 value: subject_digests: - sha256:abc123 @@ -21077,7 +21601,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &663 + default: &673 value: attestations_subject_digests: - sha256:abc: @@ -21186,7 +21710,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *96 + - *94 requestBody: required: true content: @@ -21251,7 +21775,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *96 + - *94 - name: subject_digest description: Subject Digest in: path @@ -21282,7 +21806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *96 + - *94 - name: attestation_id description: Attestation ID in: path @@ -21320,7 +21844,7 @@ paths: - *17 - *40 - *41 - - *96 + - *94 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -21371,7 +21895,7 @@ paths: bundle_url: type: string examples: - default: &366 + default: &376 value: attestations: - bundle: @@ -21478,7 +22002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -21490,7 +22014,7 @@ paths: type: array items: *4 examples: - default: &201 + default: &204 value: - login: octocat id: 1 @@ -21528,8 +22052,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *96 - - &135 + - *94 + - &138 name: username description: The handle for the GitHub user account. in: path @@ -21560,8 +22084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -21581,8 +22105,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -21607,7 +22131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *96 + - *94 - *19 - *17 - *48 @@ -21615,7 +22139,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &136 + schema: &139 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -21641,7 +22165,7 @@ paths: application/json: schema: type: array - items: &137 + items: &140 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -21672,7 +22196,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &155 + items: &158 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -21731,7 +22255,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &214 + properties: &217 id: description: Unique identifier of the team type: integer @@ -21787,7 +22311,7 @@ paths: to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &215 + required: &218 - id - node_id - url @@ -21828,7 +22352,7 @@ paths: type: string format: date-time nullable: true - state: *136 + state: *139 contact_link: description: The contact link of the campaign. type: string @@ -21949,7 +22473,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -22043,9 +22567,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *140 examples: - default: &138 + default: &141 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -22116,7 +22640,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *96 + - *94 - name: campaign_number description: The campaign number. in: path @@ -22128,9 +22652,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *140 examples: - default: *138 + default: *141 '404': *6 '422': description: Unprocessable Entity @@ -22158,7 +22682,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *96 + - *94 - name: campaign_number description: The campaign number. in: path @@ -22207,7 +22731,7 @@ paths: type: string format: uri nullable: true - state: *136 + state: *139 examples: default: value: @@ -22217,9 +22741,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *140 examples: - default: *138 + default: *141 '400': description: Bad Request content: @@ -22252,7 +22776,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *96 + - *94 - name: campaign_number description: The campaign number. in: path @@ -22285,18 +22809,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *96 - - &392 + - *94 + - &402 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false - schema: &142 + schema: &145 type: string description: The name of the tool used to generate the code scanning analysis. - - &393 + - &403 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -22304,7 +22828,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &143 + schema: &146 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -22319,7 +22843,7 @@ paths: be returned. in: query required: false - schema: &395 + schema: &405 type: string description: State of a code scanning alert. enum: @@ -22342,7 +22866,7 @@ paths: be returned. in: query required: false - schema: &396 + schema: &406 type: string description: Severity of a code scanning alert. enum: @@ -22365,16 +22889,16 @@ paths: properties: number: *54 created_at: *55 - updated_at: *139 + updated_at: *142 url: *56 html_url: *57 - instances_url: &397 + instances_url: &407 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &144 + state: &147 type: string description: State of a code scanning alert. nullable: true @@ -22382,7 +22906,7 @@ paths: - open - dismissed - fixed - fixed_at: *140 + fixed_at: *143 dismissed_by: title: Simple User description: A GitHub user. @@ -22390,8 +22914,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *141 - dismissed_reason: &398 + dismissed_at: *144 + dismissed_reason: &408 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -22400,13 +22924,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &399 + dismissed_comment: &409 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &400 + rule: &410 type: object properties: id: @@ -22459,25 +22983,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &401 + tool: &411 type: object properties: - name: *142 + name: *145 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *143 - most_recent_instance: &402 + guid: *146 + most_recent_instance: &412 type: object properties: - ref: &394 + ref: &404 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &412 + analysis_key: &422 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -22488,13 +23012,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &413 + category: &423 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *144 + state: *147 commit_sha: type: string message: @@ -22809,7 +23333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *96 + - *94 - name: target_type in: query description: The target type of the code security configuration @@ -22920,7 +23444,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *96 + - *94 requestBody: required: true content: @@ -22998,7 +23522,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *145 + code_scanning_options: *148 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -23141,7 +23665,7 @@ paths: application/json: schema: *43 examples: - default: *146 + default: *149 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23163,15 +23687,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: *147 + schema: *150 examples: - default: *148 + default: *151 '304': *37 '403': *29 '404': *6 @@ -23197,7 +23721,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *96 + - *94 requestBody: required: true content: @@ -23223,7 +23747,7 @@ paths: - 32 - 91 responses: - '204': *149 + '204': *152 '400': *14 '403': *29 '404': *6 @@ -23249,7 +23773,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *96 + - *94 - *45 responses: '200': @@ -23258,7 +23782,7 @@ paths: application/json: schema: *43 examples: - default: *146 + default: *149 '304': *37 '403': *29 '404': *6 @@ -23282,7 +23806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *96 + - *94 - *45 requestBody: required: true @@ -23539,10 +24063,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *96 + - *94 - *45 responses: - '204': *149 + '204': *152 '400': *14 '403': *29 '404': *6 @@ -23570,7 +24094,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *96 + - *94 - *45 requestBody: required: true @@ -23634,7 +24158,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *96 + - *94 - *45 requestBody: required: true @@ -23680,7 +24204,7 @@ paths: default: value: default_for_new_repos: all - configuration: *146 + configuration: *149 '403': *29 '404': *6 x-github: @@ -23704,7 +24228,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *96 + - *94 - *45 - name: per_page description: The number of results per page (max 100). For more information, @@ -23733,13 +24257,13 @@ paths: application/json: schema: type: array - items: *150 + items: *153 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *151 + repository: *154 '403': *29 '404': *6 x-github: @@ -23763,7 +24287,7 @@ paths: parameters: - *17 - *19 - - *96 + - *94 responses: '200': description: Response @@ -23779,7 +24303,7 @@ paths: type: integer codespaces: type: array - items: &202 + items: &205 type: object title: Codespace description: A codespace. @@ -23804,12 +24328,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *122 + repository: *125 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &425 + properties: &435 name: type: string description: The name of the machine. @@ -23851,7 +24375,7 @@ paths: - ready - in_progress nullable: true - required: &426 + required: &436 - name - display_name - operating_system @@ -24056,7 +24580,7 @@ paths: - pulls_url - recent_folders examples: - default: &203 + default: &206 value: total_count: 3 codespaces: @@ -24466,7 +24990,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -24488,7 +25012,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *96 + - *94 deprecated: true requestBody: required: true @@ -24532,7 +25056,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24555,7 +25079,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *96 + - *94 deprecated: true requestBody: required: true @@ -24587,7 +25111,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24610,7 +25134,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *96 + - *94 requestBody: required: true content: @@ -24641,7 +25165,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24662,7 +25186,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *96 + - *94 - *17 - *19 responses: @@ -24680,7 +25204,7 @@ paths: type: integer secrets: type: array - items: &152 + items: &155 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -24719,7 +25243,7 @@ paths: - updated_at - visibility examples: - default: &427 + default: &437 value: total_count: 2 secrets: @@ -24751,13 +25275,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &428 + schema: &438 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -24786,7 +25310,7 @@ paths: - key_id - key examples: - default: &429 + default: &439 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24809,16 +25333,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 responses: '200': description: Response content: application/json: - schema: *152 + schema: *155 examples: - default: &431 + default: &441 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -24845,8 +25369,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -24901,7 +25425,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -24927,8 +25451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 responses: '204': description: Response @@ -24953,8 +25477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - *19 - *17 responses: @@ -24972,9 +25496,9 @@ paths: type: integer repositories: type: array - items: *122 + items: *125 examples: - default: *134 + default: *137 '404': *6 x-github: githubCloudOnly: false @@ -24996,8 +25520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -25047,8 +25571,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -25081,8 +25605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -25121,7 +25645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *96 + - *94 responses: '200': description: OK @@ -25230,7 +25754,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25252,7 +25776,7 @@ paths: Only organization owners can view assigned seats. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -25262,7 +25786,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *96 + - *94 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -25285,7 +25809,7 @@ paths: currently being billed. seats: type: array - items: &205 + items: &208 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -25302,14 +25826,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *153 - required: *154 + properties: *156 + required: *157 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *155 + - *158 - title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -25477,7 +26001,7 @@ paths: site_admin: false headers: Link: *58 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25510,7 +26034,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *96 + - *94 requestBody: content: application/json: @@ -25552,7 +26076,7 @@ paths: default: value: seats_created: 5 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25588,7 +26112,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *96 + - *94 requestBody: content: application/json: @@ -25630,7 +26154,7 @@ paths: default: value: seats_cancelled: 5 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25668,7 +26192,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *96 + - *94 requestBody: content: application/json: @@ -25709,7 +26233,7 @@ paths: default: value: seats_created: 5 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25745,7 +26269,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *96 + - *94 requestBody: content: application/json: @@ -25787,7 +26311,7 @@ paths: default: value: seats_cancelled: 5 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25826,7 +26350,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *96 + - *94 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -25858,7 +26382,7 @@ paths: application/json: schema: type: array - items: &286 + items: &291 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -26165,7 +26689,7 @@ paths: - date additionalProperties: true examples: - default: &287 + default: &292 value: - date: '2024-06-24' total_active_users: 24 @@ -26264,10 +26788,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *97 + '500': *100 '403': *29 '404': *6 - '422': &288 + '422': &293 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -26294,20 +26818,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *96 - - *156 - - *157 - - *158 + - *94 - *159 - *160 - *161 - *162 - *163 + - *164 + - *165 + - *166 - *48 - *40 - *41 - - *164 - - *165 + - *167 + - *168 - *17 responses: '200': @@ -26316,9 +26840,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *167 + default: *170 '304': *37 '400': *14 '403': *29 @@ -26344,7 +26868,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *96 + - *94 - *17 - *19 responses: @@ -26362,7 +26886,7 @@ paths: type: integer secrets: type: array - items: &168 + items: &171 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -26433,13 +26957,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &458 + schema: &468 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -26456,7 +26980,7 @@ paths: - key_id - key examples: - default: &459 + default: &469 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -26479,14 +27003,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 responses: '200': description: Response content: application/json: - schema: *168 + schema: *171 examples: default: value: @@ -26514,8 +27038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -26570,7 +27094,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -26594,8 +27118,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 responses: '204': description: Response @@ -26619,8 +27143,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - *19 - *17 responses: @@ -26638,9 +27162,9 @@ paths: type: integer repositories: type: array - items: *122 + items: *125 examples: - default: *134 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26661,8 +27185,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -26712,8 +27236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -26744,8 +27268,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -26775,7 +27299,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -26783,7 +27307,7 @@ paths: application/json: schema: type: array - items: &217 + items: &220 title: Package description: A software package type: object @@ -26833,8 +27357,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *169 - required: *170 + properties: *172 + required: *173 nullable: true created_at: type: string @@ -26853,7 +27377,7 @@ paths: - created_at - updated_at examples: - default: &218 + default: &221 value: - id: 197 name: hello_docker @@ -26931,7 +27455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *96 + - *94 - *17 - *19 responses: @@ -27010,7 +27534,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *96 + - *94 - *17 - *19 responses: @@ -27020,7 +27544,7 @@ paths: application/json: schema: type: array - items: &193 + items: &196 title: Organization Invitation description: Organization Invitation type: object @@ -27067,7 +27591,7 @@ paths: - invitation_teams_url - node_id examples: - default: &194 + default: &197 value: - id: 1 login: monalisa @@ -27124,7 +27648,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *96 + - *94 - *17 - *19 responses: @@ -27134,7 +27658,7 @@ paths: application/json: schema: type: array - items: &171 + items: &174 title: Org Hook description: Org Hook type: object @@ -27245,7 +27769,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *96 + - *94 requestBody: required: true content: @@ -27305,9 +27829,9 @@ paths: description: Response content: application/json: - schema: *171 + schema: *174 examples: - default: &172 + default: &175 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -27354,8 +27878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *96 - - &173 + - *94 + - &176 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. @@ -27368,9 +27892,9 @@ paths: description: Response content: application/json: - schema: *171 + schema: *174 examples: - default: *172 + default: *175 '404': *6 x-github: githubCloudOnly: false @@ -27397,8 +27921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 requestBody: required: false content: @@ -27443,7 +27967,7 @@ paths: description: Response content: application/json: - schema: *171 + schema: *174 examples: default: value: @@ -27484,8 +28008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 responses: '204': description: Response @@ -27512,8 +28036,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *96 - - *173 + - *94 + - *176 responses: '200': description: Response @@ -27543,8 +28067,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *96 - - *173 + - *94 + - *176 requestBody: required: false content: @@ -27594,10 +28118,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 - *17 - - *174 + - *177 responses: '200': description: Response @@ -27605,9 +28129,9 @@ paths: application/json: schema: type: array - items: *175 + items: *178 examples: - default: *176 + default: *179 '400': *14 '422': *15 x-github: @@ -27632,17 +28156,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 - *16 responses: '200': description: Response content: application/json: - schema: *177 + schema: *180 examples: - default: *178 + default: *181 '400': *14 '422': *15 x-github: @@ -27667,8 +28191,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 - *16 responses: '202': *39 @@ -27697,8 +28221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 responses: '204': description: Response @@ -27720,8 +28244,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *96 - - &183 + - *94 + - &186 name: actor_type in: path description: The type of the actor @@ -27734,14 +28258,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &184 + - &187 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &179 + - &182 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -27749,7 +28273,7 @@ paths: required: true schema: type: string - - &180 + - &183 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -27842,13 +28366,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *96 - - *179 - - *180 + - *94 + - *182 + - *183 - *19 - *17 - *48 - - &189 + - &192 name: sort description: The property to sort the results by. in: query @@ -27926,15 +28450,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *96 - - *179 - - *180 + - *94 + - *182 + - *183 responses: '200': description: Response content: application/json: - schema: &181 + schema: &184 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -27950,7 +28474,7 @@ paths: type: integer format: int64 examples: - default: &182 + default: &185 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -27970,24 +28494,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *96 - - &185 + - *94 + - &188 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *179 - - *180 + - *182 + - *183 responses: '200': description: Response content: application/json: - schema: *181 + schema: *184 examples: - default: *182 + default: *185 x-github: enabledForGitHubApps: true category: orgs @@ -28005,19 +28529,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *96 - - *179 - - *180 + - *94 + - *182 - *183 - - *184 + - *186 + - *187 responses: '200': description: Response content: application/json: - schema: *181 + schema: *184 examples: - default: *182 + default: *185 x-github: enabledForGitHubApps: true category: orgs @@ -28034,10 +28558,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *96 - - *179 - - *180 - - &186 + - *94 + - *182 + - *183 + - &189 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -28050,7 +28574,7 @@ paths: description: Response content: application/json: - schema: &187 + schema: &190 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -28066,7 +28590,7 @@ paths: type: integer format: int64 examples: - default: &188 + default: &191 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -28102,19 +28626,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *96 - - *185 - - *179 - - *180 - - *186 + - *94 + - *188 + - *182 + - *183 + - *189 responses: '200': description: Response content: application/json: - schema: *187 + schema: *190 examples: - default: *188 + default: *191 x-github: enabledForGitHubApps: true category: orgs @@ -28131,20 +28655,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *96 - - *183 - - *184 - - *179 - - *180 + - *94 - *186 + - *187 + - *182 + - *183 + - *189 responses: '200': description: Response content: application/json: - schema: *187 + schema: *190 examples: - default: *188 + default: *191 x-github: enabledForGitHubApps: true category: orgs @@ -28161,14 +28685,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *96 - - *185 - - *179 - - *180 + - *94 + - *188 + - *182 + - *183 - *19 - *17 - *48 - - *189 + - *192 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -28241,7 +28765,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *96 + - *94 responses: '200': description: Response @@ -28249,7 +28773,7 @@ paths: application/json: schema: *22 examples: - default: &497 + default: &507 value: id: 1 account: @@ -28318,7 +28842,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -28407,7 +28931,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -28415,12 +28939,12 @@ paths: application/json: schema: anyOf: - - &191 + - &194 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &190 + limit: &193 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -28445,7 +28969,7 @@ paths: properties: {} additionalProperties: false examples: - default: &192 + default: &195 value: limit: collaborators_only origin: organization @@ -28469,18 +28993,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: application/json: - schema: &498 + schema: &508 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *190 + limit: *193 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -28504,9 +29028,9 @@ paths: description: Response content: application/json: - schema: *191 + schema: *194 examples: - default: *192 + default: *195 '422': *15 x-github: githubCloudOnly: false @@ -28524,7 +29048,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *96 + - *94 responses: '204': description: Response @@ -28548,7 +29072,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *96 + - *94 - *17 - *19 - name: role @@ -28582,9 +29106,9 @@ paths: application/json: schema: type: array - items: *193 + items: *196 examples: - default: *194 + default: *197 headers: Link: *58 '404': *6 @@ -28607,7 +29131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *96 + - *94 requestBody: required: false content: @@ -28661,7 +29185,7 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: default: value: @@ -28715,8 +29239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *96 - - &195 + - *94 + - &198 name: invitation_id description: The unique identifier of the invitation. in: path @@ -28746,8 +29270,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *96 - - *195 + - *94 + - *198 - *17 - *19 responses: @@ -28757,9 +29281,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: &216 + default: &219 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -28794,7 +29318,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -28802,7 +29326,7 @@ paths: application/json: schema: type: array - items: *196 + items: *199 examples: default: value: @@ -28840,7 +29364,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -28887,9 +29411,9 @@ paths: description: Response content: application/json: - schema: *196 + schema: *199 examples: - default: &197 + default: &200 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -28921,8 +29445,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *96 - - &198 + - *94 + - &201 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -28975,9 +29499,9 @@ paths: description: Response content: application/json: - schema: *196 + schema: *199 examples: - default: *197 + default: *200 '404': *6 '422': *7 x-github: @@ -29001,8 +29525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *96 - - *198 + - *94 + - *201 responses: '204': description: Response @@ -29035,7 +29559,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *96 + - *94 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -29065,7 +29589,7 @@ paths: - closed - all default: open - - *199 + - *202 - name: type description: Can be the name of an issue type. in: query @@ -29096,7 +29620,7 @@ paths: type: array items: *77 examples: - default: *200 + default: *203 headers: Link: *58 '404': *6 @@ -29118,7 +29642,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *96 + - *94 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -29156,7 +29680,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '422': *15 @@ -29176,8 +29700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response if requester is an organization member and user is @@ -29211,8 +29735,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -29238,8 +29762,8 @@ paths: parameters: - *17 - *19 - - *96 - - *135 + - *94 + - *138 responses: '200': description: Response @@ -29255,11 +29779,11 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: - default: *203 + default: *206 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -29282,9 +29806,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *96 - - *135 - - &204 + - *94 + - *138 + - &207 name: codespace_name in: path required: true @@ -29294,7 +29818,7 @@ paths: responses: '202': *39 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -29317,17 +29841,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *96 - - *135 - - *204 + - *94 + - *138 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: &424 + default: &434 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -29469,7 +29993,7 @@ paths: recent_folders: [] template: '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -29488,7 +30012,7 @@ paths: Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -29500,14 +30024,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *205 + schema: *208 examples: default: value: @@ -29550,7 +30074,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -29575,14 +30099,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '200': description: Response content: application/json: - schema: &207 + schema: &210 title: Org Membership description: Org Membership type: object @@ -29626,7 +30150,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *206 + organization: *209 user: title: Simple User description: A GitHub user. @@ -29649,7 +30173,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &208 + response-if-user-has-an-active-admin-membership-with-organization: &211 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -29717,8 +30241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 requestBody: required: false content: @@ -29746,9 +30270,9 @@ paths: description: Response content: application/json: - schema: *207 + schema: *210 examples: - response-if-user-already-had-membership-with-organization: *208 + response-if-user-already-had-membership-with-organization: *211 '422': *15 '403': *29 x-github: @@ -29772,8 +30296,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -29798,7 +30322,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *96 + - *94 - *17 - *19 - name: exclude @@ -29819,7 +30343,7 @@ paths: application/json: schema: type: array - items: &209 + items: &212 title: Migration description: A migration. type: object @@ -30072,7 +30596,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *96 + - *94 requestBody: required: true content: @@ -30148,7 +30672,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -30326,8 +30850,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *96 - - &210 + - *94 + - &213 name: migration_id description: The unique identifier of the migration. in: path @@ -30354,7 +30878,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -30523,8 +31047,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *96 - - *210 + - *94 + - *213 responses: '302': description: Response @@ -30545,8 +31069,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *96 - - *210 + - *94 + - *213 responses: '204': description: Response @@ -30569,9 +31093,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *96 - - *210 - - &645 + - *94 + - *213 + - &655 name: repo_name description: repo_name parameter in: path @@ -30598,8 +31122,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *96 - - *210 + - *94 + - *213 - *17 - *19 responses: @@ -30609,9 +31133,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: &223 + default: &226 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -30748,7 +31272,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response - list of organization roles @@ -30764,7 +31288,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &213 + items: &216 title: Organization Role description: Organization roles type: object @@ -30911,8 +31435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *96 - - &211 + - *94 + - &214 name: team_slug description: The slug of the team name. in: path @@ -30943,9 +31467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *96 - - *211 - - &212 + - *94 + - *214 + - &215 name: role_id description: The unique identifier of the role. in: path @@ -30980,9 +31504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *96 - - *211 - - *212 + - *94 + - *214 + - *215 responses: '204': description: Response @@ -31007,8 +31531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -31033,9 +31557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *96 - - *135 - - *212 + - *94 + - *138 + - *215 responses: '204': description: Response @@ -31065,9 +31589,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *96 - - *135 - - *212 + - *94 + - *138 + - *215 responses: '204': description: Response @@ -31095,14 +31619,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *96 - - *212 + - *94 + - *215 responses: '200': description: Response content: application/json: - schema: *213 + schema: *216 examples: default: value: @@ -31152,8 +31676,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *96 - - *212 + - *94 + - *215 - *17 - *19 responses: @@ -31231,8 +31755,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *214 - required: *215 + properties: *217 + required: *218 nullable: true required: - id @@ -31247,7 +31771,7 @@ paths: - slug - parent examples: - default: *216 + default: *219 headers: Link: *58 '404': @@ -31276,8 +31800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *96 - - *212 + - *94 + - *215 - *17 - *19 responses: @@ -31305,13 +31829,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &282 + items: &287 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *214 - required: *215 + properties: *217 + required: *218 name: nullable: true type: string @@ -31406,7 +31930,7 @@ paths: - type - url examples: - default: *201 + default: *204 headers: Link: *58 '404': @@ -31430,7 +31954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *96 + - *94 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -31457,7 +31981,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -31482,8 +32006,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *96 - - *135 + - *94 + - *138 requestBody: required: false content: @@ -31540,8 +32064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -31598,8 +32122,8 @@ paths: - docker - nuget - container - - *96 - - &647 + - *94 + - &657 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -31635,12 +32159,12 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: *218 + default: *221 '403': *29 '401': *25 - '400': &649 + '400': &659 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -31662,7 +32186,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &219 + - &222 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -31680,20 +32204,20 @@ paths: - docker - nuget - container - - &220 + - &223 name: package_name description: The name of the package. in: path required: true schema: type: string - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: default: value: @@ -31745,9 +32269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *219 - - *220 - - *96 + - *222 + - *223 + - *94 responses: '204': description: Response @@ -31779,9 +32303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *219 - - *220 - - *96 + - *222 + - *223 + - *94 - name: token description: package token schema: @@ -31813,9 +32337,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *219 - - *220 - - *96 + - *222 + - *223 + - *94 - *19 - *17 - name: state @@ -31835,7 +32359,7 @@ paths: application/json: schema: type: array - items: &221 + items: &224 title: Package Version description: A version of a software package type: object @@ -31960,10 +32484,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *219 - - *220 - - *96 - - &222 + - *222 + - *223 + - *94 + - &225 name: package_version_id description: Unique identifier of the package version. in: path @@ -31975,7 +32499,7 @@ paths: description: Response content: application/json: - schema: *221 + schema: *224 examples: default: value: @@ -32011,10 +32535,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *219 - - *220 - - *96 - *222 + - *223 + - *94 + - *225 responses: '204': description: Response @@ -32046,10 +32570,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *219 - - *220 - - *96 - *222 + - *223 + - *94 + - *225 responses: '204': description: Response @@ -32076,10 +32600,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *96 + - *94 - *17 - *19 - - &224 + - &227 name: sort description: The property by which to sort the results. in: query @@ -32090,7 +32614,7 @@ paths: - created_at default: created_at - *48 - - &225 + - &228 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -32101,7 +32625,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &226 + - &229 name: repository description: The name of the repository to use to filter the results. in: query @@ -32109,7 +32633,7 @@ paths: schema: type: string example: Hello-World - - &227 + - &230 name: permission description: The permission to use to filter the results. in: query @@ -32117,7 +32641,7 @@ paths: schema: type: string example: issues_read - - &228 + - &231 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -32127,7 +32651,7 @@ paths: schema: type: string format: date-time - - &229 + - &232 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -32137,7 +32661,7 @@ paths: schema: type: string format: date-time - - &230 + - &233 name: token_id description: The ID of the token in: query @@ -32149,7 +32673,7 @@ paths: type: string example: token_id[]=1,token_id[]=2 responses: - '500': *97 + '500': *100 '422': *15 '404': *6 '403': *29 @@ -32301,7 +32825,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *96 + - *94 requestBody: required: true content: @@ -32342,7 +32866,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *97 + '500': *100 '422': *15 '404': *6 '403': *29 @@ -32367,7 +32891,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *96 + - *94 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -32403,11 +32927,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *97 + '500': *100 '422': *15 '404': *6 '403': *29 - '204': *149 + '204': *152 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32428,7 +32952,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *96 + - *94 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -32439,7 +32963,7 @@ paths: - *17 - *19 responses: - '500': *97 + '500': *100 '404': *6 '403': *29 '200': @@ -32448,9 +32972,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -32473,19 +32997,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *96 + - *94 - *17 - *19 - - *224 - - *48 - - *225 - - *226 - *227 + - *48 - *228 - *229 - *230 + - *231 + - *232 + - *233 responses: - '500': *97 + '500': *100 '422': *15 '404': *6 '403': *29 @@ -32632,7 +33156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *96 + - *94 requestBody: required: true content: @@ -32667,7 +33191,7 @@ paths: - 1296269 - 1296280 responses: - '500': *97 + '500': *100 '404': *6 '202': *39 '403': *29 @@ -32692,7 +33216,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *96 + - *94 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -32720,9 +33244,9 @@ paths: value: action: revoke responses: - '500': *97 + '500': *100 '404': *6 - '204': *149 + '204': *152 '403': *29 '422': *15 x-github: @@ -32744,7 +33268,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *96 + - *94 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -32754,7 +33278,7 @@ paths: - *17 - *19 responses: - '500': *97 + '500': *100 '404': *6 '403': *29 '200': @@ -32763,9 +33287,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -32789,7 +33313,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -32807,7 +33331,7 @@ paths: type: integer configurations: type: array - items: &231 + items: &234 title: Organization private registry description: Private registry configuration for an organization type: object @@ -32895,7 +33419,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -33060,7 +33584,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &232 + org-private-registry-with-selected-visibility: &235 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -33101,7 +33625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -33149,16 +33673,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *96 - - *130 + - *94 + - *133 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *231 + schema: *234 examples: - default: *232 + default: *235 '404': *6 x-github: githubCloudOnly: false @@ -33179,8 +33703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -33275,8 +33799,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *96 - - *130 + - *94 + - *133 responses: '204': description: Response @@ -33301,7 +33825,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-organization-projects parameters: - - *96 + - *94 - name: state description: Indicates the state of the projects to return. in: query @@ -33322,7 +33846,7 @@ paths: application/json: schema: type: array - items: &233 + items: &236 title: Project description: Projects are a way to organize columns and cards of work. @@ -33469,7 +33993,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-an-organization-project parameters: - - *96 + - *94 requestBody: required: true content: @@ -33495,7 +34019,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: default: value: @@ -33533,7 +34057,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': &313 + '410': &318 description: Gone content: application/json: @@ -33560,7 +34084,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -33568,7 +34092,7 @@ paths: application/json: schema: type: array - items: &234 + items: &237 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -33634,7 +34158,7 @@ paths: - property_name - value_type examples: - default: &235 + default: &238 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -33682,7 +34206,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -33693,7 +34217,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *234 + items: *237 minItems: 1 maxItems: 100 required: @@ -33723,9 +34247,9 @@ paths: application/json: schema: type: array - items: *234 + items: *237 examples: - default: *235 + default: *238 '403': *29 '404': *6 x-github: @@ -33746,8 +34270,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *96 - - &236 + - *94 + - &239 name: custom_property_name description: The custom property name in: path @@ -33759,9 +34283,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *237 examples: - default: &237 + default: &240 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -33795,8 +34319,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *96 - - *236 + - *94 + - *239 requestBody: required: true content: @@ -33865,9 +34389,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *237 examples: - default: *237 + default: *240 '403': *29 '404': *6 x-github: @@ -33890,10 +34414,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *96 - - *236 + - *94 + - *239 responses: - '204': *149 + '204': *152 '403': *29 '404': *6 x-github: @@ -33914,7 +34438,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *96 + - *94 - *17 - *19 - name: repository_query @@ -33952,7 +34476,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &238 + items: &241 title: Custom Property Value description: Custom property name and associated value type: object @@ -34019,7 +34543,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *96 + - *94 requestBody: required: true content: @@ -34039,7 +34563,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *238 + items: *241 required: - repository_names - properties @@ -34080,7 +34604,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *96 + - *94 - *17 - *19 responses: @@ -34092,7 +34616,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -34111,8 +34635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response if user is a public member @@ -34136,8 +34660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -34158,8 +34682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -34183,7 +34707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *96 + - *94 - name: type description: Specifies the types of repositories you want returned. in: query @@ -34229,9 +34753,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -34252,7 +34776,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *96 + - *94 requestBody: required: true content: @@ -34433,7 +34957,7 @@ paths: description: Response content: application/json: - schema: &315 + schema: &320 title: Full Repository description: Full Repository type: object @@ -34710,8 +35234,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *239 - required: *240 + properties: *242 + required: *243 nullable: true temp_clone_token: type: string @@ -34826,7 +35350,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &446 + properties: &456 url: type: string format: uri @@ -34842,12 +35366,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &447 + required: &457 - url - key - name - html_url - security_and_analysis: *241 + security_and_analysis: *244 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -34931,7 +35455,7 @@ paths: - network_count - subscribers_count examples: - default: &317 + default: &322 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -35449,10 +35973,10 @@ paths: category: orgs subcategory: rules parameters: - - *96 + - *94 - *17 - *19 - - &566 + - &576 name: targets description: | A comma-separated list of rule targets to filter by. @@ -35470,7 +35994,7 @@ paths: application/json: schema: type: array - items: &267 + items: &270 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -35505,7 +36029,7 @@ paths: source: type: string description: The name of the source - enforcement: &244 + enforcement: &247 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -35518,7 +36042,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &245 + items: &248 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -35583,7 +36107,7 @@ paths: conditions: nullable: true anyOf: - - &242 + - &245 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -35607,7 +36131,7 @@ paths: match. items: type: string - - &246 + - &249 title: Organization ruleset conditions type: object description: |- @@ -35621,7 +36145,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *242 + - *245 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -35655,7 +36179,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *242 + - *245 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -35677,7 +36201,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *242 + - *245 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -35690,7 +36214,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &243 + items: &246 title: Repository ruleset property targeting definition type: object @@ -35723,17 +36247,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *243 + items: *246 required: - repository_property rules: type: array - items: &567 + items: &577 title: Repository Rule type: object description: A repository rule. oneOf: - - &247 + - &250 title: creation description: Only allow users with bypass permission to create matching refs. @@ -35745,7 +36269,7 @@ paths: type: string enum: - creation - - &248 + - &251 title: update description: Only allow users with bypass permission to update matching refs. @@ -35766,7 +36290,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &249 + - &252 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -35778,7 +36302,7 @@ paths: type: string enum: - deletion - - &250 + - &253 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -35790,7 +36314,7 @@ paths: type: string enum: - required_linear_history - - &565 + - &575 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -35868,7 +36392,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &251 + - &254 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -35892,7 +36416,7 @@ paths: type: string required: - required_deployment_environments - - &252 + - &255 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -35904,7 +36428,7 @@ paths: type: string enum: - required_signatures - - &253 + - &256 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -35966,7 +36490,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &254 + - &257 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -36014,7 +36538,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &255 + - &258 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -36026,7 +36550,7 @@ paths: type: string enum: - non_fast_forward - - &256 + - &259 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -36062,7 +36586,7 @@ paths: required: - operator - pattern - - &257 + - &260 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -36098,7 +36622,7 @@ paths: required: - operator - pattern - - &258 + - &261 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -36134,7 +36658,7 @@ paths: required: - operator - pattern - - &259 + - &262 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -36170,7 +36694,7 @@ paths: required: - operator - pattern - - &260 + - &263 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -36206,7 +36730,7 @@ paths: required: - operator - pattern - - &261 + - &264 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -36231,7 +36755,7 @@ paths: type: string required: - restricted_file_paths - - &262 + - &265 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -36255,7 +36779,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &263 + - &266 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -36278,7 +36802,7 @@ paths: type: string required: - restricted_file_extensions - - &264 + - &267 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -36303,7 +36827,7 @@ paths: maximum: 100 required: - max_file_size - - &265 + - &268 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -36353,7 +36877,7 @@ paths: - repository_id required: - workflows - - &266 + - &269 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -36450,7 +36974,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *97 + '500': *100 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -36466,7 +36990,7 @@ paths: category: orgs subcategory: rules parameters: - - *96 + - *94 requestBody: description: Request body required: true @@ -36487,23 +37011,20 @@ paths: - push - repository default: branch - enforcement: *244 + enforcement: *247 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *245 - conditions: *246 + items: *248 + conditions: *249 rules: type: array description: An array of rules within the ruleset. - items: &269 + items: &272 title: Repository Rule type: object description: A repository rule. oneOf: - - *247 - - *248 - - *249 - *250 - *251 - *252 @@ -36521,6 +37042,9 @@ paths: - *264 - *265 - *266 + - *267 + - *268 + - *269 required: - name - enforcement @@ -36558,9 +37082,9 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: &268 + default: &271 value: id: 21 name: super cool ruleset @@ -36600,7 +37124,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *97 + '500': *100 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -36614,8 +37138,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *96 - - &568 + - *94 + - &578 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -36630,7 +37154,7 @@ paths: in: query schema: type: string - - &569 + - &579 name: time_period description: |- The time period to filter by. @@ -36646,14 +37170,14 @@ paths: - week - month default: day - - &570 + - &580 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &571 + - &581 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -36673,7 +37197,7 @@ paths: description: Response content: application/json: - schema: &572 + schema: &582 title: Rule Suites description: Response type: array @@ -36728,7 +37252,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &573 + default: &583 value: - id: 21 actor_id: 12 @@ -36752,7 +37276,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36771,8 +37295,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *96 - - &574 + - *94 + - &584 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -36788,7 +37312,7 @@ paths: description: Response content: application/json: - schema: &575 + schema: &585 title: Rule Suite description: Response type: object @@ -36887,7 +37411,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &576 + default: &586 value: id: 21 actor_id: 12 @@ -36922,7 +37446,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36948,7 +37472,7 @@ paths: category: orgs subcategory: rules parameters: - - *96 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -36960,11 +37484,11 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: *268 + default: *271 '404': *6 - '500': *97 + '500': *100 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -36980,7 +37504,7 @@ paths: category: orgs subcategory: rules parameters: - - *96 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37006,16 +37530,16 @@ paths: - tag - push - repository - enforcement: *244 + enforcement: *247 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *245 - conditions: *246 + items: *248 + conditions: *249 rules: description: An array of rules within the ruleset. type: array - items: *269 + items: *272 examples: default: value: @@ -37050,11 +37574,11 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: *268 + default: *271 '404': *6 - '500': *97 + '500': *100 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -37070,7 +37594,7 @@ paths: category: orgs subcategory: rules parameters: - - *96 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37081,7 +37605,7 @@ paths: '204': description: Response '404': *6 - '500': *97 + '500': *100 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -37093,7 +37617,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *96 + - *94 - *17 - *19 - name: ruleset_id @@ -37109,7 +37633,7 @@ paths: application/json: schema: type: array - items: &270 + items: &273 title: Ruleset version type: object description: The historical version of a ruleset @@ -37133,7 +37657,7 @@ paths: type: string format: date-time examples: - default: &578 + default: &588 value: - version_id: 3 actor: @@ -37151,7 +37675,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37168,7 +37692,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *96 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37186,9 +37710,9 @@ paths: description: Response content: application/json: - schema: &579 + schema: &589 allOf: - - *270 + - *273 - type: object required: - state @@ -37235,7 +37759,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37257,15 +37781,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *96 - - *271 - - *272 - - *273 + - *94 - *274 + - *275 + - *276 + - *277 - *48 - *19 - *17 - - &580 + - &590 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -37275,7 +37799,7 @@ paths: required: false schema: type: string - - &581 + - &591 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -37285,10 +37809,10 @@ paths: required: false schema: type: string - - *275 - - *276 - - *277 - *278 + - *279 + - *280 + - *281 responses: '200': description: Response @@ -37296,9 +37820,9 @@ paths: application/json: schema: type: array - items: *279 + items: *282 examples: - default: *280 + default: *283 headers: Link: *58 '404': *6 @@ -37308,6 +37832,233 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/pattern-configurations": + get: + summary: List organization pattern configurations + description: |- + Lists the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *94 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Secret scanning pattern configuration + description: A collection of secret scanning patterns and their settings + related to push protection. + type: object + properties: + pattern_config_version: &285 + type: string + description: The version of the entity. This is used to confirm + you're updating the current version of the entity and mitigate + unintentionally overriding someone else's update. + nullable: true + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: &284 + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: string + description: The version of this pattern if it's a custom + pattern. + nullable: true + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this + pattern. + alert_total_percentage: + type: integer + description: The percentage of all alerts that this pattern + represents, rounded to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated + by this pattern. + false_positive_rate: + type: integer + description: The percentage of alerts from this pattern + that are false positives, rounded to the nearest integer. + bypass_rate: + type: integer + description: The percentage of blocks for this pattern that + were bypassed, rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this + pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: string + description: The push protection setting for this pattern + set at the enterprise level. Only present for partner + patterns when the organization has a parent enterprise. + enum: + - not-set + - disabled + - enabled + nullable: true + setting: + type: string + description: The current push protection setting for this + pattern. If this is `not-set`, then it inherits either + the enterprise setting if it exists or the default setting. + enum: + - not-set + - disabled + - enabled + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: *284 + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled + '403': *29 + '404': *6 + patch: + summary: Update organization pattern configurations + description: |- + Updates the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *94 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: *285 + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: *285 + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': *14 + '403': *29 + '404': *6 + '409': *47 + '422': *15 "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization @@ -37324,7 +38075,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *96 + - *94 - *48 - name: sort description: The property to sort the results by. @@ -37368,7 +38119,7 @@ paths: application/json: schema: type: array - items: &602 + items: &612 description: A repository security advisory. type: object properties: @@ -37588,7 +38339,7 @@ paths: login: type: string description: The username of the user credited. - type: *281 + type: *286 credits_detailed: type: array nullable: true @@ -37598,7 +38349,7 @@ paths: type: object properties: user: *4 - type: *281 + type: *286 state: type: string description: The state of the user's acceptance of the @@ -37622,7 +38373,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *155 + items: *158 private_fork: readOnly: true nullable: true @@ -37659,7 +38410,7 @@ paths: - private_fork additionalProperties: false examples: - default: &603 + default: &613 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -38038,7 +38789,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *96 + - *94 responses: '200': description: Response @@ -38046,9 +38797,9 @@ paths: application/json: schema: type: array - items: *282 + items: *287 examples: - default: *216 + default: *219 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38071,8 +38822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *96 - - *211 + - *94 + - *214 responses: '204': description: Response @@ -38097,8 +38848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *96 - - *211 + - *94 + - *214 responses: '204': description: Response @@ -38127,13 +38878,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &666 + schema: &676 type: object properties: total_minutes_used: @@ -38203,7 +38954,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &667 + default: &677 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -38233,13 +38984,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &668 + schema: &678 type: object properties: total_gigabytes_bandwidth_used: @@ -38257,7 +39008,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &669 + default: &679 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -38283,13 +39034,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &670 + schema: &680 type: object properties: days_left_in_billing_cycle: @@ -38307,7 +39058,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &671 + default: &681 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -38331,7 +39082,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -38349,7 +39100,7 @@ paths: type: integer network_configurations: type: array - items: &283 + items: &288 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -38427,7 +39178,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -38469,9 +39220,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *288 examples: - default: &284 + default: &289 value: id: 123456789ABCDEF name: My network configuration @@ -38499,8 +39250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *96 - - &285 + - *94 + - &290 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -38512,9 +39263,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *288 examples: - default: *284 + default: *289 headers: Link: *58 x-github: @@ -38535,8 +39286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *96 - - *285 + - *94 + - *290 requestBody: required: true content: @@ -38575,9 +39326,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *288 examples: - default: *284 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38596,8 +39347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *96 - - *285 + - *94 + - *290 responses: '204': description: Response @@ -38620,7 +39371,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *96 + - *94 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -38704,8 +39455,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *96 - - *211 + - *94 + - *214 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -38737,13 +39488,13 @@ paths: application/json: schema: type: array - items: *286 + items: *291 examples: - default: *287 - '500': *97 + default: *292 + '500': *100 '403': *29 '404': *6 - '422': *288 + '422': *293 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38761,7 +39512,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *96 + - *94 - *17 - *19 responses: @@ -38771,9 +39522,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 headers: Link: *58 '403': *29 @@ -38795,7 +39546,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *96 + - *94 requestBody: required: true content: @@ -38867,7 +39618,7 @@ paths: description: Response content: application/json: - schema: &289 + schema: &294 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -38930,8 +39681,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *214 - required: *215 + properties: *217 + required: *218 nullable: true members_count: type: integer @@ -39177,7 +39928,7 @@ paths: - repos_count - organization examples: - default: &290 + default: &295 value: id: 1 node_id: MDQ6VGVhbTE= @@ -39247,16 +39998,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *96 - - *211 + - *94 + - *214 responses: '200': description: Response content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '404': *6 x-github: githubCloudOnly: false @@ -39277,8 +40028,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *96 - - *211 + - *94 + - *214 requestBody: required: false content: @@ -39340,16 +40091,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '201': description: Response content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '404': *6 '422': *15 '403': *29 @@ -39374,8 +40125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *96 - - *211 + - *94 + - *214 responses: '204': description: Response @@ -39401,8 +40152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *96 - - *211 + - *94 + - *214 - *48 - *17 - *19 @@ -39419,7 +40170,7 @@ paths: application/json: schema: type: array - items: &291 + items: &296 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -39518,7 +40269,7 @@ paths: - updated_at - url examples: - default: &618 + default: &629 value: - author: login: octocat @@ -39592,8 +40343,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *96 - - *211 + - *94 + - *214 requestBody: required: true content: @@ -39627,9 +40378,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: &292 + default: &297 value: author: login: octocat @@ -39701,9 +40452,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *96 - - *211 - - &293 + - *94 + - *214 + - &298 name: discussion_number description: The number that identifies the discussion. in: path @@ -39715,9 +40466,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *292 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39739,9 +40490,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 requestBody: required: false content: @@ -39764,9 +40515,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: &619 + default: &630 value: author: login: octocat @@ -39836,9 +40587,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 responses: '204': description: Response @@ -39864,9 +40615,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 - *48 - *17 - *19 @@ -39877,7 +40628,7 @@ paths: application/json: schema: type: array - items: &294 + items: &299 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -39949,7 +40700,7 @@ paths: - updated_at - url examples: - default: &620 + default: &631 value: - author: login: octocat @@ -40017,9 +40768,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 requestBody: required: true content: @@ -40041,9 +40792,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: &295 + default: &300 value: author: login: octocat @@ -40109,10 +40860,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *96 - - *211 - - *293 - - &296 + - *94 + - *214 + - *298 + - &301 name: comment_number description: The number that identifies the comment. in: path @@ -40124,9 +40875,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: *295 + default: *300 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40148,10 +40899,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *96 - - *211 - - *293 - - *296 + - *94 + - *214 + - *298 + - *301 requestBody: required: true content: @@ -40173,9 +40924,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: &621 + default: &632 value: author: login: octocat @@ -40239,10 +40990,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *96 - - *211 - - *293 - - *296 + - *94 + - *214 + - *298 + - *301 responses: '204': description: Response @@ -40268,10 +41019,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *96 - - *211 - - *293 - - *296 + - *94 + - *214 + - *298 + - *301 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -40297,7 +41048,7 @@ paths: application/json: schema: type: array - items: &297 + items: &302 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -40340,7 +41091,7 @@ paths: - content - created_at examples: - default: &299 + default: &304 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -40390,10 +41141,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *96 - - *211 - - *293 - - *296 + - *94 + - *214 + - *298 + - *301 requestBody: required: true content: @@ -40426,9 +41177,9 @@ paths: team discussion comment content: application/json: - schema: *297 + schema: *302 examples: - default: &298 + default: &303 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -40457,9 +41208,9 @@ paths: description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40482,11 +41233,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *96 - - *211 - - *293 - - *296 - - &300 + - *94 + - *214 + - *298 + - *301 + - &305 name: reaction_id description: The unique identifier of the reaction. in: path @@ -40518,9 +41269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -40546,9 +41297,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 x-github: @@ -40574,9 +41325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 requestBody: required: true content: @@ -40608,16 +41359,16 @@ paths: description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40640,10 +41391,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *96 - - *211 - - *293 - - *300 + - *94 + - *214 + - *298 + - *305 responses: '204': description: Response @@ -40667,8 +41418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *96 - - *211 + - *94 + - *214 - *17 - *19 responses: @@ -40678,9 +41429,9 @@ paths: application/json: schema: type: array - items: *193 + items: *196 examples: - default: *194 + default: *197 headers: Link: *58 x-github: @@ -40702,8 +41453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *96 - - *211 + - *94 + - *214 - name: role description: Filters members returned by their role in the team. in: query @@ -40726,7 +41477,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -40756,15 +41507,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *96 - - *211 - - *135 + - *94 + - *214 + - *138 responses: '200': description: Response content: application/json: - schema: &301 + schema: &306 title: Team Membership description: Team Membership type: object @@ -40791,7 +41542,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &622 + response-if-user-is-a-team-maintainer: &633 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -40827,9 +41578,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *96 - - *211 - - *135 + - *94 + - *214 + - *138 requestBody: required: false content: @@ -40854,9 +41605,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *306 examples: - response-if-users-membership-with-team-is-now-pending: &623 + response-if-users-membership-with-team-is-now-pending: &634 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -40891,9 +41642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *96 - - *211 - - *135 + - *94 + - *214 + - *138 responses: '204': description: Response @@ -40918,8 +41669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *96 - - *211 + - *94 + - *214 - *17 - *19 responses: @@ -40929,7 +41680,7 @@ paths: application/json: schema: type: array - items: &302 + items: &307 title: Team Project description: A team's access to a project. type: object @@ -40997,7 +41748,7 @@ paths: - updated_at - permissions examples: - default: &624 + default: &635 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -41060,9 +41811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *96 - - *211 - - &303 + - *94 + - *214 + - &308 name: project_id description: The unique identifier of the project. in: path @@ -41074,9 +41825,9 @@ paths: description: Response content: application/json: - schema: *302 + schema: *307 examples: - default: &625 + default: &636 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -41138,9 +41889,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *96 - - *211 - - *303 + - *94 + - *214 + - *308 requestBody: required: false content: @@ -41206,9 +41957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *96 - - *211 - - *303 + - *94 + - *214 + - *308 responses: '204': description: Response @@ -41235,8 +41986,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *96 - - *211 + - *94 + - *214 - *17 - *19 responses: @@ -41246,9 +41997,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -41277,16 +42028,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *96 - - *211 - - *304 - - *305 + - *94 + - *214 + - *309 + - *310 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &626 + schema: &637 title: Team Repository description: A team's access to a repository. type: object @@ -41855,10 +42606,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *96 - - *211 - - *304 - - *305 + - *94 + - *214 + - *309 + - *310 requestBody: required: false content: @@ -41903,10 +42654,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *96 - - *211 - - *304 - - *305 + - *94 + - *214 + - *309 + - *310 responses: '204': description: Response @@ -41930,8 +42681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *96 - - *211 + - *94 + - *214 - *17 - *19 responses: @@ -41941,9 +42692,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - response-if-child-teams-exist: &627 + response-if-child-teams-exist: &638 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -41996,7 +42747,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *96 + - *94 - name: security_product in: path description: The security feature to enable or disable. @@ -42070,7 +42821,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#get-a-project-card parameters: - - &306 + - &311 name: card_id description: The unique identifier of the card. in: path @@ -42082,7 +42833,7 @@ paths: description: Response content: application/json: - schema: &307 + schema: &312 title: Project Card description: Project cards represent a scope of work. type: object @@ -42149,7 +42900,7 @@ paths: - created_at - updated_at examples: - default: &308 + default: &313 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -42205,7 +42956,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#update-an-existing-project-card parameters: - - *306 + - *311 requestBody: required: false content: @@ -42232,9 +42983,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *312 examples: - default: *308 + default: *313 '304': *37 '403': *29 '401': *25 @@ -42261,7 +43012,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#delete-a-project-card parameters: - - *306 + - *311 responses: '204': description: Response @@ -42305,7 +43056,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#move-a-project-card parameters: - - *306 + - *311 requestBody: required: true content: @@ -42416,7 +43167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column parameters: - - &309 + - &314 name: column_id description: The unique identifier of the column. in: path @@ -42428,7 +43179,7 @@ paths: description: Response content: application/json: - schema: &310 + schema: &315 title: Project Column description: Project columns contain cards of work. type: object @@ -42474,7 +43225,7 @@ paths: - created_at - updated_at examples: - default: &311 + default: &316 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -42509,7 +43260,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column parameters: - - *309 + - *314 requestBody: required: true content: @@ -42533,9 +43284,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *315 examples: - default: *311 + default: *316 '304': *37 '403': *29 '401': *25 @@ -42560,7 +43311,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column parameters: - - *309 + - *314 responses: '204': description: Response @@ -42589,7 +43340,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#list-project-cards parameters: - - *309 + - *314 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -42610,7 +43361,7 @@ paths: application/json: schema: type: array - items: *307 + items: *312 examples: default: value: @@ -42669,7 +43420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#create-a-project-card parameters: - - *309 + - *314 requestBody: required: true content: @@ -42709,9 +43460,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *312 examples: - default: *308 + default: *313 '304': *37 '403': *29 '401': *25 @@ -42721,8 +43472,8 @@ paths: application/json: schema: oneOf: - - *100 - - *101 + - *103 + - *104 '503': description: Response content: @@ -42767,7 +43518,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column parameters: - - *309 + - *314 requestBody: required: true content: @@ -42827,15 +43578,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#get-a-project parameters: - - *303 + - *308 responses: '200': description: Response content: application/json: - schema: *233 + schema: *236 examples: - default: &312 + default: &317 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -42892,7 +43643,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#update-a-project parameters: - - *303 + - *308 requestBody: required: false content: @@ -42938,9 +43689,9 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: - default: *312 + default: *317 '404': description: Not Found if the authenticated user does not have access to the project @@ -42961,7 +43712,7 @@ paths: items: type: string '401': *25 - '410': *313 + '410': *318 '422': *7 x-github: githubCloudOnly: false @@ -42984,7 +43735,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#delete-a-project parameters: - - *303 + - *308 responses: '204': description: Delete Success @@ -43005,7 +43756,7 @@ paths: items: type: string '401': *25 - '410': *313 + '410': *318 '404': *6 x-github: githubCloudOnly: false @@ -43029,7 +43780,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators parameters: - - *303 + - *308 - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's @@ -43056,7 +43807,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '404': *6 @@ -43086,8 +43837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator parameters: - - *303 - - *135 + - *308 + - *138 requestBody: required: false content: @@ -43139,8 +43890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *303 - - *135 + - *308 + - *138 responses: '204': description: Response @@ -43171,8 +43922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *303 - - *135 + - *308 + - *138 responses: '200': description: Response @@ -43245,7 +43996,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#list-project-columns parameters: - - *303 + - *308 - *17 - *19 responses: @@ -43255,7 +44006,7 @@ paths: application/json: schema: type: array - items: *310 + items: *315 examples: default: value: @@ -43293,7 +44044,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#create-a-project-column parameters: - - *303 + - *308 requestBody: required: true content: @@ -43316,7 +44067,7 @@ paths: description: Response content: application/json: - schema: *310 + schema: *315 examples: default: value: @@ -43381,7 +44132,7 @@ paths: resources: type: object properties: - core: &314 + core: &319 title: Rate Limit type: object properties: @@ -43398,21 +44149,21 @@ paths: - remaining - reset - used - graphql: *314 - search: *314 - code_search: *314 - source_import: *314 - integration_manifest: *314 - code_scanning_upload: *314 - actions_runner_registration: *314 - scim: *314 - dependency_snapshots: *314 - dependency_sbom: *314 - code_scanning_autofix: *314 + graphql: *319 + search: *319 + code_search: *319 + source_import: *319 + integration_manifest: *319 + code_scanning_upload: *319 + actions_runner_registration: *319 + scim: *319 + dependency_snapshots: *319 + dependency_sbom: *319 + code_scanning_autofix: *319 required: - core - search - rate: *314 + rate: *319 required: - rate - resources @@ -43516,14 +44267,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *315 + schema: *320 examples: default-response: summary: Default response @@ -44024,7 +44775,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *316 + '301': *321 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44042,8 +44793,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -44290,10 +45041,10 @@ paths: description: Response content: application/json: - schema: *315 + schema: *320 examples: - default: *317 - '307': &318 + default: *322 + '307': &323 description: Temporary Redirect content: application/json: @@ -44322,8 +45073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -44345,7 +45096,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *318 + '307': *323 '404': *6 '409': *47 x-github: @@ -44369,11 +45120,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 - - &344 + - &354 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -44396,7 +45147,7 @@ paths: type: integer artifacts: type: array - items: &319 + items: &324 title: Artifact description: An artifact type: object @@ -44474,7 +45225,7 @@ paths: - expires_at - updated_at examples: - default: &345 + default: &355 value: total_count: 2 artifacts: @@ -44535,9 +45286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *304 - - *305 - - &320 + - *309 + - *310 + - &325 name: artifact_id description: The unique identifier of the artifact. in: path @@ -44549,7 +45300,7 @@ paths: description: Response content: application/json: - schema: *319 + schema: *324 examples: default: value: @@ -44587,9 +45338,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *304 - - *305 - - *320 + - *309 + - *310 + - *325 responses: '204': description: Response @@ -44613,9 +45364,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *304 - - *305 - - *320 + - *309 + - *310 + - *325 - name: archive_format in: path required: true @@ -44629,7 +45380,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44652,14 +45403,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *321 + schema: *326 examples: default: value: @@ -44685,11 +45436,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 - - &322 + - &327 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -44723,7 +45474,7 @@ paths: description: Response content: application/json: - schema: &323 + schema: &328 title: Repository actions caches description: Repository actions caches type: object @@ -44765,7 +45516,7 @@ paths: - total_count - actions_caches examples: - default: &324 + default: &329 value: total_count: 1 actions_caches: @@ -44797,23 +45548,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *304 - - *305 + - *309 + - *310 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *322 + - *327 responses: '200': description: Response content: application/json: - schema: *323 + schema: *328 examples: - default: *324 + default: *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44833,8 +45584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *304 - - *305 + - *309 + - *310 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -44865,9 +45616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *304 - - *305 - - &325 + - *309 + - *310 + - &330 name: job_id description: The unique identifier of the job. in: path @@ -44879,7 +45630,7 @@ paths: description: Response content: application/json: - schema: &348 + schema: &358 title: Job description: Information of a job execution in a workflow run type: object @@ -45186,9 +45937,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *304 - - *305 - - *325 + - *309 + - *310 + - *330 responses: '302': description: Response @@ -45216,9 +45967,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *304 - - *305 - - *325 + - *309 + - *310 + - *330 requestBody: required: false content: @@ -45239,7 +45990,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -45263,8 +46014,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Status response @@ -45314,8 +46065,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -45349,7 +46100,7 @@ paths: description: Empty response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -45378,8 +46129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -45397,7 +46148,7 @@ paths: type: integer secrets: type: array - items: &350 + items: &360 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -45417,7 +46168,7 @@ paths: - created_at - updated_at examples: - default: &351 + default: &361 value: total_count: 2 secrets: @@ -45450,9 +46201,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *304 - - *305 - - *326 + - *309 + - *310 + - *331 - *19 responses: '200': @@ -45469,7 +46220,7 @@ paths: type: integer variables: type: array - items: &354 + items: &364 title: Actions Variable type: object properties: @@ -45499,7 +46250,7 @@ paths: - created_at - updated_at examples: - default: &355 + default: &365 value: total_count: 2 variables: @@ -45532,8 +46283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -45542,11 +46293,11 @@ paths: schema: type: object properties: - enabled: &328 + enabled: &333 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *111 - selected_actions_url: *327 + allowed_actions: *114 + selected_actions_url: *332 required: - enabled examples: @@ -45573,8 +46324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -45585,8 +46336,8 @@ paths: schema: type: object properties: - enabled: *328 - allowed_actions: *111 + enabled: *333 + allowed_actions: *114 required: - enabled examples: @@ -45615,14 +46366,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &329 + schema: &334 type: object properties: access_level: @@ -45639,7 +46390,7 @@ paths: required: - access_level examples: - default: &330 + default: &335 value: access_level: organization x-github: @@ -45663,15 +46414,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: application/json: - schema: *329 + schema: *334 examples: - default: *330 + default: *335 responses: '204': description: Response @@ -45681,6 +46432,196 @@ paths: previews: [] category: actions subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for a repository + description: |- + Gets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository + parameters: + - *309 + - *310 + responses: + '200': + description: Response + content: + application/json: + schema: *336 + examples: + default: + value: + days: 90 + maximum_allowed_days: 365 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for a repository + description: |- + Sets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository + parameters: + - *309 + - *310 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *337 + examples: + default: + summary: Set retention days + value: + days: 90 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for a repository + description: |- + Gets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - *309 + - *310 + responses: + '200': + description: Response + content: + application/json: + schema: *95 + examples: + default: *338 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for a repository + description: |- + Sets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - *309 + - *310 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *95 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for a repository + description: |- + Gets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - *309 + - *310 + responses: + '200': + description: Response + content: + application/json: + schema: *339 + examples: + default: *96 + '403': *29 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for a repository + description: |- + Sets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - *309 + - *310 + requestBody: + required: true + content: + application/json: + schema: *340 + examples: + default: *96 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/selected-actions": get: summary: Get allowed actions and reusable workflows for a repository @@ -45695,16 +46636,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *113 + schema: *116 examples: - default: *114 + default: *117 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -45723,8 +46664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -45732,9 +46673,9 @@ paths: required: false content: application/json: - schema: *113 + schema: *116 examples: - selected_actions: *114 + selected_actions: *117 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -45756,16 +46697,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *331 + schema: *341 examples: - default: *117 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45786,8 +46727,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Success response @@ -45798,9 +46739,9 @@ paths: required: true content: application/json: - schema: *332 + schema: *342 examples: - default: *117 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45827,8 +46768,8 @@ paths: in: query schema: type: string - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -45846,9 +46787,9 @@ paths: type: integer runners: type: array - items: *124 + items: *127 examples: - default: *125 + default: *128 headers: Link: *58 x-github: @@ -45872,8 +46813,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -45881,9 +46822,9 @@ paths: application/json: schema: type: array - items: *333 + items: *343 examples: - default: *334 + default: *344 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45905,8 +46846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -45949,7 +46890,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *335 + '201': *345 '404': *6 '422': *7 '409': *47 @@ -45980,16 +46921,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '201': description: Response content: application/json: - schema: *126 + schema: *129 examples: - default: *336 + default: *346 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46017,16 +46958,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '201': description: Response content: application/json: - schema: *126 + schema: *129 examples: - default: *337 + default: *347 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46048,17 +46989,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 responses: '200': description: Response content: application/json: - schema: *124 + schema: *127 examples: - default: *338 + default: *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46079,9 +47020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 responses: '204': description: Response @@ -46107,11 +47048,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 responses: - '200': *128 + '200': *131 '404': *6 x-github: githubCloudOnly: false @@ -46133,9 +47074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 requestBody: required: true content: @@ -46159,7 +47100,7 @@ paths: - gpu - accelerated responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -46183,9 +47124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 requestBody: required: true content: @@ -46210,7 +47151,7 @@ paths: - gpu - accelerated responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -46234,11 +47175,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 responses: - '200': *339 + '200': *349 '404': *6 x-github: githubCloudOnly: false @@ -46265,12 +47206,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 - - *340 + - *309 + - *310 + - *126 + - *350 responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -46296,9 +47237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *304 - - *305 - - &358 + - *309 + - *310 + - &368 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -46306,7 +47247,7 @@ paths: required: false schema: type: string - - &359 + - &369 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -46314,7 +47255,7 @@ paths: required: false schema: type: string - - &360 + - &370 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -46323,7 +47264,7 @@ paths: required: false schema: type: string - - &361 + - &371 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -46350,7 +47291,7 @@ paths: - pending - *17 - *19 - - &362 + - &372 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -46359,7 +47300,7 @@ paths: schema: type: string format: date-time - - &341 + - &351 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -46368,13 +47309,13 @@ paths: schema: type: boolean default: false - - &363 + - &373 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &364 + - &374 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -46397,7 +47338,7 @@ paths: type: integer workflow_runs: type: array - items: &342 + items: &352 title: Workflow Run description: An invocation of a workflow type: object @@ -46492,7 +47433,7 @@ paths: that triggered the run. type: array nullable: true - items: &383 + items: &393 title: Pull Request Minimal type: object properties: @@ -46611,7 +47552,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &387 + properties: &397 id: type: string description: SHA for the commit @@ -46662,7 +47603,7 @@ paths: - name - email nullable: true - required: &388 + required: &398 - id - tree_id - message @@ -46670,8 +47611,8 @@ paths: - author - committer nullable: true - repository: *122 - head_repository: *122 + repository: *125 + head_repository: *125 head_repository_id: type: integer example: 5 @@ -46709,7 +47650,7 @@ paths: - workflow_url - pull_requests examples: - default: &365 + default: &375 value: total_count: 1 workflow_runs: @@ -46945,24 +47886,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *304 - - *305 - - &343 + - *309 + - *310 + - &353 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *341 + - *351 responses: '200': description: Response content: application/json: - schema: *342 + schema: *352 examples: - default: &346 + default: &356 value: id: 30433642 name: Build @@ -47203,9 +48144,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '204': description: Response @@ -47228,9 +48169,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '200': description: Response @@ -47349,15 +48290,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '201': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -47384,12 +48325,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 - *17 - *19 - - *344 + - *354 responses: '200': description: Response @@ -47405,9 +48346,9 @@ paths: type: integer artifacts: type: array - items: *319 + items: *324 examples: - default: *345 + default: *355 headers: Link: *58 x-github: @@ -47431,25 +48372,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *304 - - *305 - - *343 - - &347 + - *309 + - *310 + - *353 + - &357 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *341 + - *351 responses: '200': description: Response content: application/json: - schema: *342 + schema: *352 examples: - default: *346 + default: *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47472,10 +48413,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *304 - - *305 - - *343 - - *347 + - *309 + - *310 + - *353 + - *357 - *17 - *19 responses: @@ -47493,9 +48434,9 @@ paths: type: integer jobs: type: array - items: *348 + items: *358 examples: - default: &349 + default: &359 value: total_count: 1 jobs: @@ -47608,10 +48549,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *304 - - *305 - - *343 - - *347 + - *309 + - *310 + - *353 + - *357 responses: '302': description: Response @@ -47639,15 +48580,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '202': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -47674,9 +48615,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 requestBody: required: true content: @@ -47743,15 +48684,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '202': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -47778,9 +48719,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -47810,9 +48751,9 @@ paths: type: integer jobs: type: array - items: *348 + items: *358 examples: - default: *349 + default: *359 headers: Link: *58 x-github: @@ -47837,9 +48778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '302': description: Response @@ -47866,14 +48807,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '204': description: Response '403': *29 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47895,9 +48836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '200': description: Response @@ -47957,7 +48898,7 @@ paths: items: type: object properties: - type: &467 + type: &477 type: string description: The type of reviewer. enum: @@ -47967,7 +48908,7 @@ paths: reviewer: anyOf: - *4 - - *155 + - *158 required: - environment - wait_timer @@ -48042,9 +48983,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 requestBody: required: true content: @@ -48091,7 +49032,7 @@ paths: application/json: schema: type: array - items: &462 + items: &472 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -48197,7 +49138,7 @@ paths: - created_at - updated_at examples: - default: &463 + default: &473 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -48253,9 +49194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 requestBody: required: false content: @@ -48276,7 +49217,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -48299,9 +49240,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 requestBody: required: false content: @@ -48322,7 +49263,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -48354,9 +49295,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '200': description: Response @@ -48493,8 +49434,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -48512,9 +49453,9 @@ paths: type: integer secrets: type: array - items: *350 + items: *360 examples: - default: *351 + default: *361 headers: Link: *58 x-github: @@ -48539,16 +49480,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *352 + schema: *362 examples: - default: *353 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48570,17 +49511,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '200': description: Response content: application/json: - schema: *350 + schema: *360 examples: - default: &480 + default: &490 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -48606,9 +49547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 requestBody: required: true content: @@ -48639,7 +49580,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -48665,9 +49606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '204': description: Response @@ -48692,9 +49633,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *304 - - *305 - - *326 + - *309 + - *310 + - *331 - *19 responses: '200': @@ -48711,9 +49652,9 @@ paths: type: integer variables: type: array - items: *354 + items: *364 examples: - default: *355 + default: *365 headers: Link: *58 x-github: @@ -48736,8 +49677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -48764,7 +49705,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -48789,17 +49730,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *304 - - *305 - - *133 + - *309 + - *310 + - *136 responses: '200': description: Response content: application/json: - schema: *354 + schema: *364 examples: - default: &481 + default: &491 value: name: USERNAME value: octocat @@ -48825,9 +49766,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *304 - - *305 - - *133 + - *309 + - *310 + - *136 requestBody: required: true content: @@ -48869,9 +49810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *304 - - *305 - - *133 + - *309 + - *310 + - *136 responses: '204': description: Response @@ -48896,8 +49837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -48915,7 +49856,7 @@ paths: type: integer workflows: type: array - items: &356 + items: &366 title: Workflow description: A GitHub Actions workflow type: object @@ -49022,9 +49963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *304 - - *305 - - &357 + - *309 + - *310 + - &367 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -49039,7 +49980,7 @@ paths: description: Response content: application/json: - schema: *356 + schema: *366 examples: default: value: @@ -49072,9 +50013,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *304 - - *305 - - *357 + - *309 + - *310 + - *367 responses: '204': description: Response @@ -49099,9 +50040,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *304 - - *305 - - *357 + - *309 + - *310 + - *367 responses: '204': description: Response @@ -49152,9 +50093,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *304 - - *305 - - *357 + - *309 + - *310 + - *367 responses: '204': description: Response @@ -49181,19 +50122,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *304 - - *305 - - *357 - - *358 - - *359 - - *360 - - *361 + - *309 + - *310 + - *367 + - *368 + - *369 + - *370 + - *371 - *17 - *19 - - *362 - - *341 - - *363 - - *364 + - *372 + - *351 + - *373 + - *374 responses: '200': description: Response @@ -49209,9 +50150,9 @@ paths: type: integer workflow_runs: type: array - items: *342 + items: *352 examples: - default: *365 + default: *375 headers: Link: *58 x-github: @@ -49243,9 +50184,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *304 - - *305 - - *357 + - *309 + - *310 + - *367 responses: '200': description: Response @@ -49306,8 +50247,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *304 - - *305 + - *309 + - *310 - *48 - *17 - *40 @@ -49471,8 +50412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -49484,7 +50425,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '404': *6 @@ -49509,8 +50450,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *304 - - *305 + - *309 + - *310 - name: assignee in: path required: true @@ -49546,8 +50487,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -49659,8 +50600,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *40 - *41 @@ -49714,7 +50655,7 @@ paths: bundle_url: type: string examples: - default: *366 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49734,8 +50675,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -49743,7 +50684,7 @@ paths: application/json: schema: type: array - items: &367 + items: &377 title: Autolink reference description: An autolink reference. type: object @@ -49793,8 +50734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -49833,9 +50774,9 @@ paths: description: response content: application/json: - schema: *367 + schema: *377 examples: - default: &368 + default: &378 value: id: 1 key_prefix: TICKET- @@ -49866,9 +50807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *304 - - *305 - - &369 + - *309 + - *310 + - &379 name: autolink_id description: The unique identifier of the autolink. in: path @@ -49880,9 +50821,9 @@ paths: description: Response content: application/json: - schema: *367 + schema: *377 examples: - default: *368 + default: *378 '404': *6 x-github: githubCloudOnly: false @@ -49902,9 +50843,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *304 - - *305 - - *369 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -49928,8 +50869,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response if Dependabot is enabled @@ -49977,8 +50918,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -49999,8 +50940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -50020,8 +50961,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *304 - - *305 + - *309 + - *310 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -50059,7 +51000,7 @@ paths: - url protected: type: boolean - protection: &371 + protection: &381 title: Branch Protection description: Branch Protection type: object @@ -50101,7 +51042,7 @@ paths: required: - contexts - checks - enforce_admins: &374 + enforce_admins: &384 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -50116,7 +51057,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &376 + required_pull_request_reviews: &386 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -50137,7 +51078,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *155 + items: *158 apps: description: The list of apps with review dismissal access. @@ -50166,7 +51107,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *155 + items: *158 apps: description: The list of apps allowed to bypass pull request requirements. @@ -50192,7 +51133,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &373 + restrictions: &383 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -50499,9 +51440,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *304 - - *305 - - &372 + - *309 + - *310 + - &382 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -50515,14 +51456,14 @@ paths: description: Response content: application/json: - schema: &382 + schema: &392 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &435 + commit: &445 title: Commit description: Commit type: object @@ -50556,7 +51497,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &370 + properties: &380 name: type: string example: '"Chris Wanstrath"' @@ -50571,7 +51512,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *370 + properties: *380 nullable: true message: type: string @@ -50592,7 +51533,7 @@ paths: required: - sha - url - verification: &487 + verification: &497 title: Verification type: object properties: @@ -50626,12 +51567,12 @@ paths: nullable: true oneOf: - *4 - - *131 + - *134 committer: nullable: true oneOf: - *4 - - *131 + - *134 parents: type: array items: @@ -50662,7 +51603,7 @@ paths: type: integer files: type: array - items: &450 + items: &460 title: Diff Entry description: Diff Entry type: object @@ -50745,7 +51686,7 @@ paths: - self protected: type: boolean - protection: *371 + protection: *381 protection_url: type: string format: uri @@ -50852,7 +51793,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *316 + '301': *321 '404': *6 x-github: githubCloudOnly: false @@ -50874,15 +51815,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *371 + schema: *381 examples: default: value: @@ -51076,9 +52017,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -51333,7 +52274,7 @@ paths: url: type: string format: uri - required_status_checks: &379 + required_status_checks: &389 title: Status Check Policy description: Status Check Policy type: object @@ -51409,7 +52350,7 @@ paths: items: *4 teams: type: array - items: *155 + items: *158 apps: type: array items: *5 @@ -51427,7 +52368,7 @@ paths: items: *4 teams: type: array - items: *155 + items: *158 apps: type: array items: *5 @@ -51485,7 +52426,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *373 + restrictions: *383 required_conversation_resolution: type: object properties: @@ -51597,9 +52538,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -51624,17 +52565,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *374 + schema: *384 examples: - default: &375 + default: &385 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -51656,17 +52597,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *374 + schema: *384 examples: - default: *375 + default: *385 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51685,9 +52626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -51712,17 +52653,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *376 + schema: *386 examples: - default: &377 + default: &387 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -51818,9 +52759,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -51918,9 +52859,9 @@ paths: description: Response content: application/json: - schema: *376 + schema: *386 examples: - default: *377 + default: *387 '422': *15 x-github: githubCloudOnly: false @@ -51941,9 +52882,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -51970,17 +52911,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *374 + schema: *384 examples: - default: &378 + default: &388 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -52003,17 +52944,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *374 + schema: *384 examples: - default: *378 + default: *388 '404': *6 x-github: githubCloudOnly: false @@ -52033,9 +52974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -52060,17 +53001,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *379 + schema: *389 examples: - default: &380 + default: &390 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -52096,9 +53037,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -52150,9 +53091,9 @@ paths: description: Response content: application/json: - schema: *379 + schema: *389 examples: - default: *380 + default: *390 '404': *6 '422': *15 x-github: @@ -52174,9 +53115,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -52200,9 +53141,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response @@ -52236,9 +53177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -52305,9 +53246,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -52371,9 +53312,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: content: application/json: @@ -52439,15 +53380,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *373 + schema: *383 examples: default: value: @@ -52538,9 +53479,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -52563,9 +53504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response @@ -52575,7 +53516,7 @@ paths: type: array items: *5 examples: - default: &381 + default: &391 value: - id: 1 slug: octoapp @@ -52632,9 +53573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -52668,7 +53609,7 @@ paths: type: array items: *5 examples: - default: *381 + default: *391 '422': *15 x-github: githubCloudOnly: false @@ -52689,9 +53630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -52725,7 +53666,7 @@ paths: type: array items: *5 examples: - default: *381 + default: *391 '422': *15 x-github: githubCloudOnly: false @@ -52746,9 +53687,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -52782,7 +53723,7 @@ paths: type: array items: *5 examples: - default: *381 + default: *391 '422': *15 x-github: githubCloudOnly: false @@ -52804,9 +53745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response @@ -52814,9 +53755,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 '404': *6 x-github: githubCloudOnly: false @@ -52836,9 +53777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -52874,9 +53815,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 '422': *15 x-github: githubCloudOnly: false @@ -52897,9 +53838,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -52935,9 +53876,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 '422': *15 x-github: githubCloudOnly: false @@ -52958,9 +53899,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: content: application/json: @@ -52995,9 +53936,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 '422': *15 x-github: githubCloudOnly: false @@ -53019,9 +53960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response @@ -53031,7 +53972,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '404': *6 x-github: githubCloudOnly: false @@ -53055,9 +53996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -53090,7 +54031,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -53115,9 +54056,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -53150,7 +54091,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -53175,9 +54116,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -53210,7 +54151,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -53237,9 +54178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -53261,7 +54202,7 @@ paths: description: Response content: application/json: - schema: *382 + schema: *392 examples: default: value: @@ -53377,8 +54318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -53657,7 +54598,7 @@ paths: description: Response content: application/json: - schema: &384 + schema: &394 title: CheckRun description: A check performed on the code of a given code change type: object @@ -53776,8 +54717,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *383 - deployment: &684 + items: *393 + deployment: &694 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -54057,9 +54998,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *304 - - *305 - - &385 + - *309 + - *310 + - &395 name: check_run_id description: The unique identifier of the check run. in: path @@ -54071,9 +55012,9 @@ paths: description: Response content: application/json: - schema: *384 + schema: *394 examples: - default: &386 + default: &396 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -54173,9 +55114,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *304 - - *305 - - *385 + - *309 + - *310 + - *395 requestBody: required: true content: @@ -54415,9 +55356,9 @@ paths: description: Response content: application/json: - schema: *384 + schema: *394 examples: - default: *386 + default: *396 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54437,9 +55378,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *304 - - *305 - - *385 + - *309 + - *310 + - *395 - *17 - *19 responses: @@ -54534,15 +55475,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *304 - - *305 - - *385 + - *309 + - *310 + - *395 responses: '201': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -54580,8 +55521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -54603,7 +55544,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &389 + schema: &399 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -54667,7 +55608,7 @@ paths: nullable: true pull_requests: type: array - items: *383 + items: *393 nullable: true app: title: GitHub app @@ -54680,7 +55621,7 @@ paths: nullable: true properties: *61 required: *62 - repository: *122 + repository: *125 created_at: type: string format: date-time @@ -54689,12 +55630,12 @@ paths: type: string format: date-time nullable: true - head_commit: &710 + head_commit: &720 title: Simple Commit description: A commit. type: object - properties: *387 - required: *388 + properties: *397 + required: *398 latest_check_runs_count: type: integer check_runs_url: @@ -54722,7 +55663,7 @@ paths: - check_runs_url - pull_requests examples: - default: &390 + default: &400 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -55013,9 +55954,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *389 + schema: *399 examples: - default: *390 + default: *400 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55034,8 +55975,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -55096,7 +56037,7 @@ paths: required: - app_id - setting - repository: *122 + repository: *125 examples: default: value: @@ -55344,9 +56285,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *304 - - *305 - - &391 + - *309 + - *310 + - &401 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -55358,9 +56299,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *399 examples: - default: *390 + default: *400 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55383,17 +56324,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *304 - - *305 - - *391 - - &443 + - *309 + - *310 + - *401 + - &453 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &444 + - &454 name: status description: Returns check runs with the specified `status`. in: query @@ -55432,9 +56373,9 @@ paths: type: integer check_runs: type: array - items: *384 + items: *394 examples: - default: &445 + default: &455 value: total_count: 1 check_runs: @@ -55536,15 +56477,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *304 - - *305 - - *391 + - *309 + - *310 + - *401 responses: '201': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -55571,21 +56512,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *304 - - *305 - - *392 - - *393 + - *309 + - *310 + - *402 + - *403 - *19 - *17 - - &410 + - &420 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *394 - - &411 + schema: *404 + - &421 name: pr description: The number of the pull request for the results you want to list. in: query @@ -55610,13 +56551,13 @@ paths: be returned. in: query required: false - schema: *395 + schema: *405 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *396 + schema: *406 responses: '200': description: Response @@ -55629,12 +56570,12 @@ paths: properties: number: *54 created_at: *55 - updated_at: *139 + updated_at: *142 url: *56 html_url: *57 - instances_url: *397 - state: *144 - fixed_at: *140 + instances_url: *407 + state: *147 + fixed_at: *143 dismissed_by: title: Simple User description: A GitHub user. @@ -55642,12 +56583,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *141 - dismissed_reason: *398 - dismissed_comment: *399 - rule: *400 - tool: *401 - most_recent_instance: *402 + dismissed_at: *144 + dismissed_reason: *408 + dismissed_comment: *409 + rule: *410 + tool: *411 + most_recent_instance: *412 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -55770,7 +56711,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &403 + '403': &413 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -55797,9 +56738,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *304 - - *305 - - &404 + - *309 + - *310 + - &414 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -55813,17 +56754,17 @@ paths: description: Response content: application/json: - schema: &405 + schema: &415 type: object properties: number: *54 created_at: *55 - updated_at: *139 + updated_at: *142 url: *56 html_url: *57 - instances_url: *397 - state: *144 - fixed_at: *140 + instances_url: *407 + state: *147 + fixed_at: *143 dismissed_by: title: Simple User description: A GitHub user. @@ -55831,9 +56772,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *141 - dismissed_reason: *398 - dismissed_comment: *399 + dismissed_at: *144 + dismissed_reason: *408 + dismissed_comment: *409 rule: type: object properties: @@ -55887,8 +56828,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *401 - most_recent_instance: *402 + tool: *411 + most_recent_instance: *412 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -55984,7 +56925,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -56004,9 +56945,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 requestBody: required: true content: @@ -56021,8 +56962,8 @@ paths: enum: - open - dismissed - dismissed_reason: *398 - dismissed_comment: *399 + dismissed_reason: *408 + dismissed_comment: *409 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -56041,7 +56982,7 @@ paths: description: Response content: application/json: - schema: *405 + schema: *415 examples: default: value: @@ -56117,7 +57058,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &409 + '403': &419 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -56144,15 +57085,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 responses: '200': description: Response content: application/json: - schema: &406 + schema: &416 type: object properties: status: @@ -56178,13 +57119,13 @@ paths: - description - started_at examples: - default: &407 + default: &417 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &408 + '400': &418 description: Bad Request content: application/json: @@ -56195,7 +57136,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -56220,29 +57161,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 responses: '200': description: OK content: application/json: - schema: *406 + schema: *416 examples: - default: *407 + default: *417 '202': description: Accepted content: application/json: - schema: *406 + schema: *416 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *408 + '400': *418 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -56274,9 +57215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 requestBody: required: false content: @@ -56321,8 +57262,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *408 - '403': *409 + '400': *418 + '403': *419 '404': *6 '422': description: Unprocessable Entity @@ -56346,13 +57287,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 - *19 - *17 - - *410 - - *411 + - *420 + - *421 responses: '200': description: Response @@ -56360,7 +57301,7 @@ paths: application/json: schema: type: array - items: *402 + items: *412 examples: default: value: @@ -56399,7 +57340,7 @@ paths: end_column: 50 classifications: - source - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -56433,25 +57374,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *304 - - *305 - - *392 - - *393 + - *309 + - *310 + - *402 + - *403 - *19 - *17 - - *411 + - *421 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *394 + schema: *404 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &414 + schema: &424 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -56472,23 +57413,23 @@ paths: application/json: schema: type: array - items: &415 + items: &425 type: object properties: - ref: *394 - commit_sha: &423 + ref: *404 + commit_sha: &433 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *412 + analysis_key: *422 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *413 + category: *423 error: type: string example: error reading field xyz @@ -56512,8 +57453,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *414 - tool: *401 + sarif_id: *424 + tool: *411 deletable: type: boolean warning: @@ -56574,7 +57515,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -56610,8 +57551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -56624,7 +57565,7 @@ paths: description: Response content: application/json: - schema: *415 + schema: *425 examples: response: summary: application/json response @@ -56678,7 +57619,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *403 + '403': *413 '404': *6 '422': description: Response if analysis could not be processed @@ -56765,8 +57706,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -56819,7 +57760,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *409 + '403': *419 '404': *6 '503': *65 x-github: @@ -56841,8 +57782,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -56850,7 +57791,7 @@ paths: application/json: schema: type: array - items: &416 + items: &426 title: CodeQL Database description: A CodeQL database. type: object @@ -56961,7 +57902,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -56990,8 +57931,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: language in: path description: The language of the CodeQL database. @@ -57003,7 +57944,7 @@ paths: description: Response content: application/json: - schema: *416 + schema: *426 examples: default: value: @@ -57035,9 +57976,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &452 + '302': &462 description: Found - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -57059,8 +58000,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *304 - - *305 + - *309 + - *310 - name: language in: path description: The language of the CodeQL database. @@ -57070,7 +58011,7 @@ paths: responses: '204': description: Response - '403': *409 + '403': *419 '404': *6 '503': *65 x-github: @@ -57098,8 +58039,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -57108,7 +58049,7 @@ paths: type: object additionalProperties: false properties: - language: &417 + language: &427 type: string description: The language targeted by the CodeQL query enum: @@ -57187,7 +58128,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &421 + schema: &431 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -57197,7 +58138,7 @@ paths: description: The ID of the variant analysis. controller_repo: *53 actor: *4 - query_language: *417 + query_language: *427 query_pack_url: type: string description: The download url for the query pack. @@ -57244,7 +58185,7 @@ paths: items: type: object properties: - repository: &418 + repository: &428 title: Repository Identifier description: Repository Identifier type: object @@ -57280,7 +58221,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &422 + analysis_status: &432 type: string description: The new status of the CodeQL variant analysis repository task. @@ -57312,7 +58253,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &419 + access_mismatch_repos: &429 type: object properties: repository_count: @@ -57326,7 +58267,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *418 + items: *428 required: - repository_count - repositories @@ -57348,8 +58289,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *419 - over_limit_repos: *419 + no_codeql_db_repos: *429 + over_limit_repos: *429 required: - access_mismatch_repos - not_found_repos @@ -57365,7 +58306,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &420 + value: &430 summary: Default response value: id: 1 @@ -57517,10 +58458,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *420 + value: *430 repository_lists: summary: Response for a successful variant analysis submission - value: *420 + value: *430 '404': *6 '422': description: Unable to process variant analysis submission @@ -57548,8 +58489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *304 - - *305 + - *309 + - *310 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -57561,9 +58502,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *431 examples: - default: *420 + default: *430 '404': *6 '503': *65 x-github: @@ -57586,7 +58527,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *304 + - *309 - name: repo in: path description: The name of the controller repository. @@ -57621,7 +58562,7 @@ paths: type: object properties: repository: *53 - analysis_status: *422 + analysis_status: *432 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -57746,8 +58687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -57832,7 +58773,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -57853,8 +58794,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -57921,7 +58862,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -57946,7 +58887,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *409 + '403': *419 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -58017,8 +58958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -58026,7 +58967,7 @@ paths: schema: type: object properties: - commit_sha: *423 + commit_sha: *433 ref: type: string description: |- @@ -58084,7 +59025,7 @@ paths: schema: type: object properties: - id: *414 + id: *424 url: type: string description: The REST API URL for checking the status of the upload. @@ -58098,7 +59039,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *409 + '403': *419 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -58121,8 +59062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *304 - - *305 + - *309 + - *310 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -58168,7 +59109,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *403 + '403': *413 '404': description: Not Found if the sarif id does not match any upload '503': *65 @@ -58193,8 +59134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -58250,7 +59191,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *149 + '204': *152 '304': *37 '403': *29 '404': *6 @@ -58275,8 +59216,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *304 - - *305 + - *309 + - *310 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -58396,8 +59337,8 @@ paths: parameters: - *17 - *19 - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -58413,7 +59354,7 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: default: value: @@ -58689,7 +59630,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': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -58711,8 +59652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -58775,17 +59716,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '400': *14 '401': *25 '403': *29 @@ -58814,8 +59755,8 @@ paths: parameters: - *17 - *19 - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -58855,7 +59796,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *97 + '500': *100 '400': *14 '401': *25 '403': *29 @@ -58879,8 +59820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -58915,14 +59856,14 @@ paths: type: integer machines: type: array - items: &634 + items: &645 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *425 - required: *426 + properties: *435 + required: *436 examples: - default: &635 + default: &646 value: total_count: 2 machines: @@ -58939,7 +59880,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -58962,8 +59903,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *304 - - *305 + - *309 + - *310 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -59047,8 +59988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *304 - - *305 + - *309 + - *310 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -59114,8 +60055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -59133,7 +60074,7 @@ paths: type: integer secrets: type: array - items: &430 + items: &440 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -59153,7 +60094,7 @@ paths: - created_at - updated_at examples: - default: *427 + default: *437 headers: Link: *58 x-github: @@ -59176,16 +60117,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *428 + schema: *438 examples: - default: *429 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59205,17 +60146,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '200': description: Response content: application/json: - schema: *430 + schema: *440 examples: - default: *431 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59235,9 +60176,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 requestBody: required: true content: @@ -59265,7 +60206,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -59289,9 +60230,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '204': description: Response @@ -59319,8 +60260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *304 - - *305 + - *309 + - *310 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -59362,7 +60303,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &432 + properties: &442 login: type: string example: octocat @@ -59455,7 +60396,7 @@ paths: user_view_type: type: string example: public - required: &433 + required: &443 - avatar_url - events_url - followers_url @@ -59529,9 +60470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *304 - - *305 - - *135 + - *309 + - *310 + - *138 responses: '204': description: Response if user is a collaborator @@ -59577,9 +60518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *304 - - *305 - - *135 + - *309 + - *310 + - *138 requestBody: required: false content: @@ -59605,7 +60546,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &500 + schema: &510 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -59616,7 +60557,7 @@ paths: example: 42 type: integer format: int64 - repository: *122 + repository: *125 invitee: title: Simple User description: A GitHub user. @@ -59794,7 +60735,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *100 + schema: *103 '403': *29 x-github: triggersNotification: true @@ -59834,9 +60775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *304 - - *305 - - *135 + - *309 + - *310 + - *138 responses: '204': description: No Content when collaborator was removed from the repository. @@ -59867,9 +60808,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *304 - - *305 - - *135 + - *309 + - *310 + - *138 responses: '200': description: if user has admin permissions @@ -59889,8 +60830,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *432 - required: *433 + properties: *442 + required: *443 nullable: true required: - permission @@ -59945,8 +60886,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -59956,7 +60897,7 @@ paths: application/json: schema: type: array - items: &434 + items: &444 title: Commit Comment description: Commit Comment type: object @@ -60014,7 +60955,7 @@ paths: - created_at - updated_at examples: - default: &437 + default: &447 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -60073,17 +61014,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '200': description: Response content: application/json: - schema: *434 + schema: *444 examples: - default: &438 + default: &448 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -60140,8 +61081,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -60164,7 +61105,7 @@ paths: description: Response content: application/json: - schema: *434 + schema: *444 examples: default: value: @@ -60215,8 +61156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '204': @@ -60238,8 +61179,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -60266,9 +61207,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 '404': *6 @@ -60289,8 +61230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -60323,16 +61264,16 @@ paths: description: Reaction exists content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Reaction created content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -60354,10 +61295,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *304 - - *305 + - *309 + - *310 - *76 - - *300 + - *305 responses: '204': description: Response @@ -60406,8 +61347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *304 - - *305 + - *309 + - *310 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -60463,9 +61404,9 @@ paths: application/json: schema: type: array - items: *435 + items: *445 examples: - default: &551 + default: &561 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -60536,7 +61477,7 @@ paths: sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: Link: *58 - '500': *97 + '500': *100 '400': *14 '404': *6 '409': *47 @@ -60559,9 +61500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *304 - - *305 - - &436 + - *309 + - *310 + - &446 name: commit_sha description: The SHA of the commit. in: path @@ -60633,9 +61574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *304 - - *305 - - *436 + - *309 + - *310 + - *446 - *17 - *19 responses: @@ -60645,9 +61586,9 @@ paths: application/json: schema: type: array - items: *434 + items: *444 examples: - default: *437 + default: *447 headers: Link: *58 x-github: @@ -60675,9 +61616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *304 - - *305 - - *436 + - *309 + - *310 + - *446 requestBody: required: true content: @@ -60712,9 +61653,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *444 examples: - default: *438 + default: *448 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -60742,9 +61683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *304 - - *305 - - *436 + - *309 + - *310 + - *446 - *17 - *19 responses: @@ -60754,7 +61695,7 @@ paths: application/json: schema: type: array - items: &542 + items: &552 title: Pull Request Simple description: Pull Request Simple type: object @@ -60860,8 +61801,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *439 - required: *440 + properties: *449 + required: *450 nullable: true active_lock_reason: type: string @@ -60906,7 +61847,7 @@ paths: nullable: true requested_teams: type: array - items: *155 + items: *158 nullable: true head: type: object @@ -60957,7 +61898,7 @@ paths: _links: type: object properties: - comments: &441 + comments: &451 title: Link description: Hypermedia Link type: object @@ -60966,13 +61907,13 @@ paths: type: string required: - href - commits: *441 - statuses: *441 - html: *441 - issue: *441 - review_comments: *441 - review_comment: *441 - self: *441 + commits: *451 + statuses: *451 + html: *451 + issue: *451 + review_comments: *451 + review_comment: *451 + self: *451 required: - comments - commits @@ -60983,7 +61924,7 @@ paths: - review_comment - self author_association: *63 - auto_merge: &544 + auto_merge: &554 title: Auto merge description: The status of auto merging a pull request. type: object @@ -61046,7 +61987,7 @@ paths: - author_association - auto_merge examples: - default: &543 + default: &553 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -61583,11 +62524,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *304 - - *305 + - *309 + - *310 - *19 - *17 - - &442 + - &452 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -61602,9 +62543,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *445 examples: - default: &529 + default: &539 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -61690,7 +62631,7 @@ paths: ..... '422': *15 '404': *6 - '500': *97 + '500': *100 '503': *65 '409': *47 x-github: @@ -61717,11 +62658,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *304 - - *305 - - *442 - - *443 - - *444 + - *309 + - *310 + - *452 + - *453 + - *454 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -61755,9 +62696,9 @@ paths: type: integer check_runs: type: array - items: *384 + items: *394 examples: - default: *445 + default: *455 headers: Link: *58 x-github: @@ -61782,9 +62723,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *304 - - *305 - - *442 + - *309 + - *310 + - *452 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -61792,7 +62733,7 @@ paths: schema: type: integer example: 1 - - *443 + - *453 - *17 - *19 responses: @@ -61810,7 +62751,7 @@ paths: type: integer check_suites: type: array - items: *389 + items: *399 examples: default: value: @@ -62010,9 +62951,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *304 - - *305 - - *442 + - *309 + - *310 + - *452 - *17 - *19 responses: @@ -62079,7 +63020,7 @@ paths: type: string total_count: type: integer - repository: *122 + repository: *125 commit_url: type: string format: uri @@ -62210,9 +63151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *304 - - *305 - - *442 + - *309 + - *310 + - *452 - *17 - *19 responses: @@ -62222,7 +63163,7 @@ paths: application/json: schema: type: array - items: &607 + items: &617 title: Status description: The status of a commit. type: object @@ -62303,7 +63244,7 @@ paths: site_admin: false headers: Link: *58 - '301': *316 + '301': *321 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62331,8 +63272,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -62361,20 +63302,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *446 - required: *447 + properties: *456 + required: *457 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &448 + properties: &458 url: type: string format: uri html_url: type: string format: uri - required: &449 + required: &459 - url - html_url nullable: true @@ -62388,26 +63329,26 @@ paths: contributing: title: Community Health File type: object - properties: *448 - required: *449 + properties: *458 + required: *459 nullable: true readme: title: Community Health File type: object - properties: *448 - required: *449 + properties: *458 + required: *459 nullable: true issue_template: title: Community Health File type: object - properties: *448 - required: *449 + properties: *458 + required: *459 nullable: true pull_request_template: title: Community Health File type: object - properties: *448 - required: *449 + properties: *458 + required: *459 nullable: true required: - code_of_conduct @@ -62534,8 +63475,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *304 - - *305 + - *309 + - *310 - *19 - *17 - name: basehead @@ -62578,8 +63519,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *435 - merge_base_commit: *435 + base_commit: *445 + merge_base_commit: *445 status: type: string enum: @@ -62599,10 +63540,10 @@ paths: example: 6 commits: type: array - items: *435 + items: *445 files: type: array - items: *450 + items: *460 required: - url - html_url @@ -62845,7 +63786,7 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *97 + '500': *100 '503': *65 x-github: githubCloudOnly: false @@ -62888,8 +63829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *304 - - *305 + - *309 + - *310 - name: path description: path parameter in: path @@ -63032,7 +63973,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &451 + response-if-content-is-a-file: &461 summary: Response if content is a file value: type: file @@ -63164,7 +64105,7 @@ paths: - size - type - url - - &556 + - &566 title: Content File description: Content File type: object @@ -63365,7 +64306,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *451 + response-if-content-is-a-file: *461 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -63434,7 +64375,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *452 + '302': *462 '304': *37 x-github: githubCloudOnly: false @@ -63457,8 +64398,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *304 - - *305 + - *309 + - *310 - name: path description: path parameter in: path @@ -63551,7 +64492,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &463 title: File Commit description: File Commit type: object @@ -63703,7 +64644,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *463 examples: example-for-creating-a-file: value: @@ -63757,7 +64698,7 @@ paths: schema: oneOf: - *3 - - &482 + - &492 description: Repository rule violation was detected type: object properties: @@ -63778,7 +64719,7 @@ paths: items: type: object properties: - placeholder_id: &599 + placeholder_id: &609 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -63810,8 +64751,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *304 - - *305 + - *309 + - *310 - name: path description: path parameter in: path @@ -63872,7 +64813,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *463 examples: default: value: @@ -63927,8 +64868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *304 - - *305 + - *309 + - *310 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -64051,22 +64992,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *304 - - *305 - - *156 - - *157 - - *158 + - *309 + - *310 - *159 + - *160 + - *161 + - *162 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *160 - - *161 - - *162 - *163 + - *164 + - *165 + - *166 - *48 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -64086,8 +65027,8 @@ paths: default: 30 - *40 - *41 - - *164 - - *165 + - *167 + - *168 responses: '200': description: Response @@ -64095,7 +65036,7 @@ paths: application/json: schema: type: array - items: &456 + items: &466 type: object description: A Dependabot alert. properties: @@ -64141,13 +65082,13 @@ paths: - unknown - direct - transitive - security_advisory: *454 + security_advisory: *464 security_vulnerability: *52 url: *56 html_url: *57 created_at: *55 - updated_at: *139 - dismissed_at: *141 + updated_at: *142 + dismissed_at: *144 dismissed_by: title: Simple User description: A GitHub user. @@ -64171,8 +65112,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *140 - auto_dismissed_at: *455 + fixed_at: *143 + auto_dismissed_at: *465 required: - number - state @@ -64402,9 +65343,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *304 - - *305 - - &457 + - *309 + - *310 + - &467 name: alert_number in: path description: |- @@ -64419,7 +65360,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *466 examples: default: value: @@ -64532,9 +65473,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *304 - - *305 - - *457 + - *309 + - *310 + - *467 requestBody: required: true content: @@ -64579,7 +65520,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *466 examples: default: value: @@ -64708,8 +65649,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -64727,7 +65668,7 @@ paths: type: integer secrets: type: array - items: &460 + items: &470 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -64780,16 +65721,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *458 + schema: *468 examples: - default: *459 + default: *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64809,15 +65750,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '200': description: Response content: application/json: - schema: *460 + schema: *470 examples: default: value: @@ -64843,9 +65784,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 requestBody: required: true content: @@ -64873,7 +65814,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -64897,9 +65838,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '204': description: Response @@ -64921,8 +65862,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *304 - - *305 + - *309 + - *310 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -65082,8 +66023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -65322,8 +66263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -65398,7 +66339,7 @@ paths: - version - url additionalProperties: false - metadata: &461 + metadata: &471 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -65431,7 +66372,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *461 + metadata: *471 resolved: type: object description: A collection of resolved package dependencies. @@ -65444,7 +66385,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *461 + metadata: *471 relationship: type: string description: A notation of whether a dependency is requested @@ -65573,8 +66514,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *304 - - *305 + - *309 + - *310 - name: sha description: The SHA recorded at creation time. in: query @@ -65614,9 +66555,9 @@ paths: application/json: schema: type: array - items: *462 + items: *472 examples: - default: *463 + default: *473 headers: Link: *58 x-github: @@ -65682,8 +66623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -65764,7 +66705,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *472 examples: simple-example: summary: Simple example @@ -65837,9 +66778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *304 - - *305 - - &464 + - *309 + - *310 + - &474 name: deployment_id description: deployment_id parameter in: path @@ -65851,7 +66792,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *472 examples: default: value: @@ -65916,9 +66857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *304 - - *305 - - *464 + - *309 + - *310 + - *474 responses: '204': description: Response @@ -65940,9 +66881,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *304 - - *305 - - *464 + - *309 + - *310 + - *474 - *17 - *19 responses: @@ -65952,7 +66893,7 @@ paths: application/json: schema: type: array - items: &465 + items: &475 title: Deployment Status description: The status of a deployment. type: object @@ -66113,9 +67054,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *304 - - *305 - - *464 + - *309 + - *310 + - *474 requestBody: required: true content: @@ -66190,9 +67131,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *475 examples: - default: &466 + default: &476 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -66248,9 +67189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *304 - - *305 - - *464 + - *309 + - *310 + - *474 - name: status_id in: path required: true @@ -66261,9 +67202,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *475 examples: - default: *466 + default: *476 '404': *6 x-github: githubCloudOnly: false @@ -66288,8 +67229,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -66346,8 +67287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -66364,7 +67305,7 @@ paths: type: integer environments: type: array - items: &468 + items: &478 title: Environment description: Details of a deployment environment type: object @@ -66416,7 +67357,7 @@ paths: type: type: string example: wait_timer - wait_timer: &470 + wait_timer: &480 type: integer example: 30 description: The amount of time to delay a job after @@ -66453,11 +67394,11 @@ paths: items: type: object properties: - type: *467 + type: *477 reviewer: anyOf: - *4 - - *155 + - *158 required: - id - node_id @@ -66477,7 +67418,7 @@ paths: - id - node_id - type - deployment_branch_policy: &471 + deployment_branch_policy: &481 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -66593,9 +67534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *304 - - *305 - - &469 + - *309 + - *310 + - &479 name: environment_name in: path required: true @@ -66608,9 +67549,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *478 examples: - default: &472 + default: &482 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -66694,9 +67635,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 requestBody: required: false content: @@ -66705,7 +67646,7 @@ paths: type: object nullable: true properties: - wait_timer: *470 + wait_timer: *480 prevent_self_review: type: boolean example: false @@ -66722,13 +67663,13 @@ paths: items: type: object properties: - type: *467 + type: *477 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *471 + deployment_branch_policy: *481 additionalProperties: false examples: default: @@ -66748,9 +67689,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *478 examples: - default: *472 + default: *482 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -66774,9 +67715,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 responses: '204': description: Default response @@ -66801,9 +67742,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 - *17 - *19 responses: @@ -66821,7 +67762,7 @@ paths: example: 2 branch_policies: type: array - items: &473 + items: &483 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -66878,9 +67819,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 requestBody: required: true content: @@ -66926,9 +67867,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *483 examples: - example-wildcard: &474 + example-wildcard: &484 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -66970,10 +67911,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *304 - - *305 - - *469 - - &475 + - *309 + - *310 + - *479 + - &485 name: branch_policy_id in: path required: true @@ -66985,9 +67926,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *483 examples: - default: *474 + default: *484 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67006,10 +67947,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *304 - - *305 - - *469 - - *475 + - *309 + - *310 + - *479 + - *485 requestBody: required: true content: @@ -67037,9 +67978,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *483 examples: - default: *474 + default: *484 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67058,10 +67999,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *304 - - *305 - - *469 - - *475 + - *309 + - *310 + - *479 + - *485 responses: '204': description: Response @@ -67086,9 +68027,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *469 - - *305 - - *304 + - *479 + - *310 + - *309 responses: '200': description: List of deployment protection rules @@ -67104,7 +68045,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &476 + items: &486 title: Deployment protection rule description: Deployment protection rule type: object @@ -67123,7 +68064,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &477 + app: &487 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -67222,9 +68163,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *469 - - *305 - - *304 + - *479 + - *310 + - *309 requestBody: content: application/json: @@ -67245,9 +68186,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *476 + schema: *486 examples: - default: &478 + default: &488 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -67282,9 +68223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *469 - - *305 - - *304 + - *479 + - *310 + - *309 - *19 - *17 responses: @@ -67303,7 +68244,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *477 + items: *487 examples: default: value: @@ -67338,10 +68279,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *304 - - *305 - - *469 - - &479 + - *309 + - *310 + - *479 + - &489 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -67353,9 +68294,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *486 examples: - default: *478 + default: *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67376,10 +68317,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *469 - - *305 - - *304 - *479 + - *310 + - *309 + - *489 responses: '204': description: Response @@ -67405,9 +68346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 - *17 - *19 responses: @@ -67425,9 +68366,9 @@ paths: type: integer secrets: type: array - items: *350 + items: *360 examples: - default: *351 + default: *361 headers: Link: *58 x-github: @@ -67452,17 +68393,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 responses: '200': description: Response content: application/json: - schema: *352 + schema: *362 examples: - default: *353 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67484,18 +68425,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *304 - - *305 - - *469 - - *130 + - *309 + - *310 + - *479 + - *133 responses: '200': description: Response content: application/json: - schema: *350 + schema: *360 examples: - default: *480 + default: *490 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67517,10 +68458,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *304 - - *305 - - *469 - - *130 + - *309 + - *310 + - *479 + - *133 requestBody: required: true content: @@ -67551,7 +68492,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -67577,10 +68518,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *304 - - *305 - - *469 - - *130 + - *309 + - *310 + - *479 + - *133 responses: '204': description: Default response @@ -67605,10 +68546,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *304 - - *305 - - *469 - - *326 + - *309 + - *310 + - *479 + - *331 - *19 responses: '200': @@ -67625,9 +68566,9 @@ paths: type: integer variables: type: array - items: *354 + items: *364 examples: - default: *355 + default: *365 headers: Link: *58 x-github: @@ -67650,9 +68591,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 requestBody: required: true content: @@ -67679,7 +68620,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -67704,18 +68645,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *304 - - *305 - - *469 - - *133 + - *309 + - *310 + - *479 + - *136 responses: '200': description: Response content: application/json: - schema: *354 + schema: *364 examples: - default: *481 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67736,10 +68677,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *304 - - *305 - - *133 - - *469 + - *309 + - *310 + - *136 + - *479 requestBody: required: true content: @@ -67781,10 +68722,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *304 - - *305 - - *133 - - *469 + - *309 + - *310 + - *136 + - *479 responses: '204': description: Response @@ -67806,8 +68747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -67884,8 +68825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *304 - - *305 + - *309 + - *310 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -67907,7 +68848,7 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: default: value: @@ -68044,8 +68985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -68077,9 +69018,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *320 examples: - default: *317 + default: *322 '400': *14 '422': *15 '403': *29 @@ -68100,8 +69041,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -68160,8 +69101,8 @@ paths: application/json: schema: oneOf: - - *100 - - *482 + - *103 + - *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68186,8 +69127,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *304 - - *305 + - *309 + - *310 - name: file_sha in: path required: true @@ -68286,8 +69227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -68396,7 +69337,7 @@ paths: description: Response content: application/json: - schema: &483 + schema: &493 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -68610,15 +69551,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *304 - - *305 - - *436 + - *309 + - *310 + - *446 responses: '200': description: Response content: application/json: - schema: *483 + schema: *493 examples: default: value: @@ -68674,9 +69615,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *304 - - *305 - - &484 + - *309 + - *310 + - &494 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -68693,7 +69634,7 @@ paths: application/json: schema: type: array - items: &485 + items: &495 title: Git Reference description: Git references within a repository type: object @@ -68768,17 +69709,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *304 - - *305 - - *484 + - *309 + - *310 + - *494 responses: '200': description: Response content: application/json: - schema: *485 + schema: *495 examples: - default: &486 + default: &496 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -68807,8 +69748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -68837,9 +69778,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *495 examples: - default: *486 + default: *496 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -68865,9 +69806,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *304 - - *305 - - *484 + - *309 + - *310 + - *494 requestBody: required: true content: @@ -68896,9 +69837,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *495 examples: - default: *486 + default: *496 '422': *15 '409': *47 x-github: @@ -68916,9 +69857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *304 - - *305 - - *484 + - *309 + - *310 + - *494 responses: '204': description: Response @@ -68973,8 +69914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -69041,7 +69982,7 @@ paths: description: Response content: application/json: - schema: &488 + schema: &498 title: Git Tag description: Metadata for a Git tag type: object @@ -69092,7 +70033,7 @@ paths: - sha - type - url - verification: *487 + verification: *497 required: - sha - url @@ -69102,7 +70043,7 @@ paths: - tag - message examples: - default: &489 + default: &499 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -69175,8 +70116,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *304 - - *305 + - *309 + - *310 - name: tag_sha in: path required: true @@ -69187,9 +70128,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *498 examples: - default: *489 + default: *499 '404': *6 '409': *47 x-github: @@ -69213,8 +70154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -69287,7 +70228,7 @@ paths: description: Response content: application/json: - schema: &490 + schema: &500 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -69383,8 +70324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *304 - - *305 + - *309 + - *310 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -69407,7 +70348,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *500 examples: default-response: summary: Default response @@ -69466,8 +70407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -69477,7 +70418,7 @@ paths: application/json: schema: type: array - items: &491 + items: &501 title: Webhook description: Webhooks for repositories. type: object @@ -69531,7 +70472,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &718 + last_response: &728 title: Hook Response type: object properties: @@ -69605,8 +70546,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -69658,9 +70599,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *501 examples: - default: &492 + default: &502 value: type: Repository id: 12345678 @@ -69708,17 +70649,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 responses: '200': description: Response content: application/json: - schema: *491 + schema: *501 examples: - default: *492 + default: *502 '404': *6 x-github: githubCloudOnly: false @@ -69738,9 +70679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 requestBody: required: true content: @@ -69785,9 +70726,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *501 examples: - default: *492 + default: *502 '422': *15 '404': *6 x-github: @@ -69808,9 +70749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 responses: '204': description: Response @@ -69834,9 +70775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 responses: '200': description: Response @@ -69863,9 +70804,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 requestBody: required: false content: @@ -69909,11 +70850,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 - *17 - - *174 + - *177 responses: '200': description: Response @@ -69921,9 +70862,9 @@ paths: application/json: schema: type: array - items: *175 + items: *178 examples: - default: *176 + default: *179 '400': *14 '422': *15 x-github: @@ -69942,18 +70883,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 - *16 responses: '200': description: Response content: application/json: - schema: *177 + schema: *180 examples: - default: *178 + default: *181 '400': *14 '422': *15 x-github: @@ -69972,9 +70913,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 - *16 responses: '202': *39 @@ -69997,9 +70938,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 responses: '204': description: Response @@ -70024,9 +70965,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 responses: '204': description: Response @@ -70084,14 +71025,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &493 + schema: &503 title: Import description: A repository import from an external source. type: object @@ -70190,7 +71131,7 @@ paths: - html_url - authors_url examples: - default: &496 + default: &506 value: vcs: subversion use_lfs: true @@ -70206,7 +71147,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &494 + '503': &504 description: Unavailable due to service under maintenance. content: application/json: @@ -70235,8 +71176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -70284,7 +71225,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *503 examples: default: value: @@ -70309,7 +71250,7 @@ paths: type: string '422': *15 '404': *6 - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70337,8 +71278,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -70387,7 +71328,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *503 examples: example-1: summary: Example 1 @@ -70435,7 +71376,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70458,12 +71399,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70489,9 +71430,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *304 - - *305 - - &658 + - *309 + - *310 + - &668 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -70505,7 +71446,7 @@ paths: application/json: schema: type: array - items: &495 + items: &505 title: Porter Author description: Porter Author type: object @@ -70559,7 +71500,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70584,8 +71525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *304 - - *305 + - *309 + - *310 - name: author_id in: path required: true @@ -70615,7 +71556,7 @@ paths: description: Response content: application/json: - schema: *495 + schema: *505 examples: default: value: @@ -70628,7 +71569,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70652,8 +71593,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -70694,7 +71635,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70722,8 +71663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -70750,11 +71691,11 @@ paths: description: Response content: application/json: - schema: *493 + schema: *503 examples: - default: *496 + default: *506 '422': *15 - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70777,8 +71718,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -70786,8 +71727,8 @@ paths: application/json: schema: *22 examples: - default: *497 - '301': *316 + default: *507 + '301': *321 '404': *6 x-github: githubCloudOnly: false @@ -70807,8 +71748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -70816,12 +71757,12 @@ paths: application/json: schema: anyOf: - - *191 + - *194 - type: object properties: {} additionalProperties: false examples: - default: &499 + default: &509 value: limit: collaborators_only origin: repository @@ -70846,13 +71787,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: application/json: - schema: *498 + schema: *508 examples: default: summary: Example request body @@ -70864,9 +71805,9 @@ paths: description: Response content: application/json: - schema: *191 + schema: *194 examples: - default: *499 + default: *509 '409': description: Response x-github: @@ -70888,8 +71829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -70912,8 +71853,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -70923,9 +71864,9 @@ paths: application/json: schema: type: array - items: *500 + items: *510 examples: - default: &651 + default: &661 value: - id: 1 repository: @@ -71056,9 +71997,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *304 - - *305 - - *195 + - *309 + - *310 + - *198 requestBody: required: false content: @@ -71087,7 +72028,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *510 examples: default: value: @@ -71218,9 +72159,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *304 - - *305 - - *195 + - *309 + - *310 + - *198 responses: '204': description: Response @@ -71251,8 +72192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *304 - - *305 + - *309 + - *310 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -71300,7 +72241,7 @@ paths: required: false schema: type: string - - *199 + - *202 - name: sort description: What to sort results by. in: query @@ -71325,7 +72266,7 @@ paths: type: array items: *77 examples: - default: &511 + default: &519 value: - id: 1 node_id: MDU6SXNzdWUx @@ -71473,7 +72414,7 @@ paths: state_reason: completed headers: Link: *58 - '301': *316 + '301': *321 '422': *15 '404': *6 x-github: @@ -71502,8 +72443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -71587,7 +72528,7 @@ paths: application/json: schema: *77 examples: - default: &506 + default: &516 value: id: 1 node_id: MDU6SXNzdWUx @@ -71743,7 +72684,7 @@ paths: '422': *15 '503': *65 '404': *6 - '410': *313 + '410': *318 x-github: triggersNotification: true githubCloudOnly: false @@ -71771,8 +72712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *87 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -71793,9 +72734,9 @@ paths: application/json: schema: type: array - items: *501 + items: *511 examples: - default: &508 + default: &518 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -71853,17 +72794,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '200': description: Response content: application/json: - schema: *501 + schema: *511 examples: - default: &502 + default: &512 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -71917,8 +72858,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -71941,9 +72882,9 @@ paths: description: Response content: application/json: - schema: *501 + schema: *511 examples: - default: *502 + default: *512 '422': *15 x-github: githubCloudOnly: false @@ -71961,8 +72902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '204': @@ -71983,8 +72924,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -72011,9 +72952,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 '404': *6 @@ -72034,8 +72975,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -72068,16 +73009,16 @@ paths: description: Reaction exists content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Reaction created content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -72099,10 +73040,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *304 - - *305 + - *309 + - *310 - *76 - - *300 + - *305 responses: '204': description: Response @@ -72122,8 +73063,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -72133,7 +73074,7 @@ paths: application/json: schema: type: array - items: &505 + items: &515 title: Issue Event description: Issue Event type: object @@ -72176,8 +73117,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *503 - required: *504 + properties: *513 + required: *514 nullable: true label: title: Issue Event Label @@ -72221,7 +73162,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *155 + requested_team: *158 dismissed_review: title: Issue Event Dismissed Review type: object @@ -72484,8 +73425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *304 - - *305 + - *309 + - *310 - name: event_id in: path required: true @@ -72496,7 +73437,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *515 examples: default: value: @@ -72689,7 +73630,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *313 + '410': *318 '403': *29 x-github: githubCloudOnly: false @@ -72723,9 +73664,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *304 - - *305 - - &507 + - *309 + - *310 + - &517 name: issue_number description: The number that identifies the issue. in: path @@ -72739,10 +73680,10 @@ paths: application/json: schema: *77 examples: - default: *506 - '301': *316 + default: *516 + '301': *321 '404': *6 - '410': *313 + '410': *318 '304': *37 x-github: githubCloudOnly: false @@ -72767,9 +73708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: false content: @@ -72875,13 +73816,13 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 '422': *15 '503': *65 '403': *29 - '301': *316 + '301': *321 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72899,9 +73840,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: false content: @@ -72929,7 +73870,7 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72945,9 +73886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: content: application/json: @@ -72974,7 +73915,7 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72996,9 +73937,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - name: assignee in: path required: true @@ -73038,9 +73979,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - *67 - *17 - *19 @@ -73051,13 +73992,13 @@ paths: application/json: schema: type: array - items: *501 + items: *511 examples: - default: *508 + default: *518 headers: Link: *58 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73086,9 +74027,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: true content: @@ -73110,16 +74051,16 @@ paths: description: Response content: application/json: - schema: *501 + schema: *511 examples: - default: *502 + default: *512 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *313 + '410': *318 '422': *15 '404': *6 x-github: @@ -73128,6 +74069,210 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": + get: + summary: List dependencies an issue is blocked by + description: |- + You can use the REST API to list the dependencies an issue is blocked by. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - *309 + - *310 + - *517 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *77 + examples: + default: *519 + headers: + Link: *58 + '301': *321 + '404': *6 + '410': *318 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + post: + summary: Add a dependency an issue is blocked by + description: |- + You can use the REST API to add a 'blocked by' relationship to an issue. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - *309 + - *310 + - *517 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: *77 + examples: + default: *516 + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': *321 + '403': *29 + '410': *318 + '422': *15 + '404': *6 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": + delete: + summary: Remove dependency an issue is blocked by + description: |- + You can use the REST API to remove a dependency that an issue is blocked by. + + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - *309 + - *310 + - *517 + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *77 + examples: + default: *516 + '301': *321 + '400': *14 + '401': *25 + '403': *29 + '404': *6 + '410': *318 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": + get: + summary: List dependencies an issue is blocking + description: |- + You can use the REST API to list the dependencies an issue is blocking. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - *309 + - *310 + - *517 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *77 + examples: + default: *519 + headers: + Link: *58 + '301': *321 + '404': *6 + '410': *318 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events @@ -73139,9 +74284,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - *17 - *19 responses: @@ -73155,7 +74300,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &512 + - &522 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -73209,7 +74354,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &513 + - &523 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -73345,7 +74490,7 @@ paths: - performed_via_github_app - assignee - assigner - - &514 + - &524 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -73396,7 +74541,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &515 + - &525 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -73447,7 +74592,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &516 + - &526 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -73501,7 +74646,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &517 + - &527 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -73535,7 +74680,7 @@ paths: properties: *61 required: *62 review_requester: *4 - requested_team: *155 + requested_team: *158 requested_reviewer: *4 required: - review_requester @@ -73548,7 +74693,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &518 + - &528 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -73582,7 +74727,7 @@ paths: properties: *61 required: *62 review_requester: *4 - requested_team: *155 + requested_team: *158 requested_reviewer: *4 required: - review_requester @@ -73595,7 +74740,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &519 + - &529 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -73655,7 +74800,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &520 + - &530 title: Locked Issue Event description: Locked Issue Event type: object @@ -73703,7 +74848,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &521 + - &531 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -73769,7 +74914,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &522 + - &532 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -73835,7 +74980,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &523 + - &533 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -73901,7 +75046,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &524 + - &534 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -73992,7 +75137,7 @@ paths: color: red headers: Link: *58 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74009,9 +75154,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - *17 - *19 responses: @@ -74021,7 +75166,7 @@ paths: application/json: schema: type: array - items: &509 + items: &520 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -74068,7 +75213,7 @@ paths: - color - default examples: - default: &510 + default: &521 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -74086,9 +75231,9 @@ paths: default: false headers: Link: *58 - '301': *316 + '301': *321 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74105,9 +75250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: false content: @@ -74166,12 +75311,12 @@ paths: application/json: schema: type: array - items: *509 + items: *520 examples: - default: *510 - '301': *316 + default: *521 + '301': *321 '404': *6 - '410': *313 + '410': *318 '422': *15 x-github: githubCloudOnly: false @@ -74188,9 +75333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: false content: @@ -74250,12 +75395,12 @@ paths: application/json: schema: type: array - items: *509 + items: *520 examples: - default: *510 - '301': *316 + default: *521 + '301': *321 '404': *6 - '410': *313 + '410': *318 '422': *15 x-github: githubCloudOnly: false @@ -74272,15 +75417,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 responses: '204': description: Response - '301': *316 + '301': *321 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74299,9 +75444,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - name: name in: path required: true @@ -74314,7 +75459,7 @@ paths: application/json: schema: type: array - items: *509 + items: *520 examples: default: value: @@ -74325,9 +75470,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *316 + '301': *321 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74347,9 +75492,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: false content: @@ -74377,7 +75522,7 @@ paths: '204': description: Response '403': *29 - '410': *313 + '410': *318 '404': *6 '422': *15 x-github: @@ -74395,9 +75540,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 responses: '204': description: Response @@ -74419,9 +75564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -74447,13 +75592,13 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74471,9 +75616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: true content: @@ -74505,16 +75650,16 @@ paths: description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -74536,10 +75681,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *304 + - *309 + - *310 + - *517 - *305 - - *507 - - *300 responses: '204': description: Response @@ -74568,9 +75713,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: true content: @@ -74594,7 +75739,7 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -74627,9 +75772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - *17 - *19 responses: @@ -74641,11 +75786,11 @@ paths: type: array items: *77 examples: - default: *511 + default: *519 headers: Link: *58 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74673,9 +75818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: true content: @@ -74704,14 +75849,14 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *313 + '410': *318 '422': *15 '404': *6 x-github: @@ -74731,9 +75876,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: true content: @@ -74766,7 +75911,7 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 '403': *29 '404': *6 '422': *7 @@ -74788,9 +75933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - *17 - *19 responses: @@ -74805,19 +75950,19 @@ paths: description: Timeline Event type: object anyOf: - - *512 - - *513 - - *514 - - *515 - - *516 - - *517 - - *518 - - *519 - - *520 - - *521 - *522 - *523 - *524 + - *525 + - *526 + - *527 + - *528 + - *529 + - *530 + - *531 + - *532 + - *533 + - *534 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -75122,7 +76267,7 @@ paths: type: string comments: type: array - items: &545 + items: &555 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -75331,7 +76476,7 @@ paths: type: string comments: type: array - items: *434 + items: *444 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -75620,7 +76765,7 @@ paths: headers: Link: *58 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75637,8 +76782,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -75648,7 +76793,7 @@ paths: application/json: schema: type: array - items: &525 + items: &535 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -75714,8 +76859,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -75751,9 +76896,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *535 examples: - default: &526 + default: &536 value: id: 1 key: ssh-rsa AAA... @@ -75787,9 +76932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *304 - - *305 - - &527 + - *309 + - *310 + - &537 name: key_id description: The unique identifier of the key. in: path @@ -75801,9 +76946,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *535 examples: - default: *526 + default: *536 '404': *6 x-github: githubCloudOnly: false @@ -75821,9 +76966,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *304 - - *305 - - *527 + - *309 + - *310 + - *537 responses: '204': description: Response @@ -75843,8 +76988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -75854,9 +76999,9 @@ paths: application/json: schema: type: array - items: *509 + items: *520 examples: - default: *510 + default: *521 headers: Link: *58 '404': *6 @@ -75877,8 +77022,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -75914,9 +77059,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *520 examples: - default: &528 + default: &538 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -75948,8 +77093,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *304 - - *305 + - *309 + - *310 - name: name in: path required: true @@ -75960,9 +77105,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *520 examples: - default: *528 + default: *538 '404': *6 x-github: githubCloudOnly: false @@ -75979,8 +77124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *304 - - *305 + - *309 + - *310 - name: name in: path required: true @@ -76019,7 +77164,7 @@ paths: description: Response content: application/json: - schema: *509 + schema: *520 examples: default: value: @@ -76045,8 +77190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *304 - - *305 + - *309 + - *310 - name: name in: path required: true @@ -76072,8 +77217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -76112,9 +77257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *304 - - *305 - - *410 + - *309 + - *310 + - *420 responses: '200': description: Response @@ -76259,8 +77404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -76325,8 +77470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -76360,9 +77505,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *435 + schema: *445 examples: - default: *529 + default: *539 '204': description: Response when already merged '404': @@ -76387,8 +77532,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *304 - - *305 + - *309 + - *310 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -76429,12 +77574,12 @@ paths: application/json: schema: type: array - items: &530 + items: &540 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *439 - required: *440 + properties: *449 + required: *450 examples: default: value: @@ -76490,8 +77635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -76531,9 +77676,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *540 examples: - default: &531 + default: &541 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -76592,9 +77737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *304 - - *305 - - &532 + - *309 + - *310 + - &542 name: milestone_number description: The number that identifies the milestone. in: path @@ -76606,9 +77751,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *540 examples: - default: *531 + default: *541 '404': *6 x-github: githubCloudOnly: false @@ -76625,9 +77770,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *304 - - *305 - - *532 + - *309 + - *310 + - *542 requestBody: required: false content: @@ -76665,9 +77810,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *540 examples: - default: *531 + default: *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76683,9 +77828,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *304 - - *305 - - *532 + - *309 + - *310 + - *542 responses: '204': description: Response @@ -76706,9 +77851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *304 - - *305 - - *532 + - *309 + - *310 + - *542 - *17 - *19 responses: @@ -76718,9 +77863,9 @@ paths: application/json: schema: type: array - items: *509 + items: *520 examples: - default: *510 + default: *521 headers: Link: *58 x-github: @@ -76739,12 +77884,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *304 - - *305 - - *533 - - *534 + - *309 + - *310 + - *543 + - *544 - *67 - - *535 + - *545 - *17 - *19 responses: @@ -76756,7 +77901,7 @@ paths: type: array items: *90 examples: - default: *536 + default: *546 headers: Link: *58 x-github: @@ -76780,8 +77925,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -76839,14 +77984,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &537 + schema: &547 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -76971,7 +78116,7 @@ paths: - custom_404 - public examples: - default: &538 + default: &548 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -77012,8 +78157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -77067,9 +78212,9 @@ paths: description: Response content: application/json: - schema: *537 + schema: *547 examples: - default: *538 + default: *548 '422': *15 '409': *47 x-github: @@ -77092,8 +78237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -77192,8 +78337,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -77219,8 +78364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -77230,7 +78375,7 @@ paths: application/json: schema: type: array - items: &539 + items: &549 title: Page Build description: Page Build type: object @@ -77324,8 +78469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *304 - - *305 + - *309 + - *310 responses: '201': description: Response @@ -77370,16 +78515,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *539 + schema: *549 examples: - default: &540 + default: &550 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -77427,8 +78572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *304 - - *305 + - *309 + - *310 - name: build_id in: path required: true @@ -77439,9 +78584,9 @@ paths: description: Response content: application/json: - schema: *539 + schema: *549 examples: - default: *540 + default: *550 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77461,8 +78606,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -77567,9 +78712,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *304 - - *305 - - &541 + - *309 + - *310 + - &551 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -77627,11 +78772,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *304 - - *305 - - *541 + - *309 + - *310 + - *551 responses: - '204': *149 + '204': *152 '404': *6 x-github: githubCloudOnly: false @@ -77656,8 +78801,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -77888,7 +79033,7 @@ paths: description: Empty response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -77915,8 +79060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Private vulnerability reporting status @@ -77953,10 +79098,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: - '204': *149 + '204': *152 '422': *14 x-github: githubCloudOnly: false @@ -77975,10 +79120,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: - '204': *149 + '204': *152 '422': *14 x-github: githubCloudOnly: false @@ -77999,8 +79144,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects parameters: - - *304 - - *305 + - *309 + - *310 - name: state description: Indicates the state of the projects to return. in: query @@ -78021,7 +79166,7 @@ paths: application/json: schema: type: array - items: *233 + items: *236 examples: default: value: @@ -78061,7 +79206,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *313 + '410': *318 '422': *7 x-github: githubCloudOnly: false @@ -78084,8 +79229,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -78111,13 +79256,13 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: - default: *312 + default: *317 '401': *25 '403': *29 '404': *6 - '410': *313 + '410': *318 '422': *7 x-github: githubCloudOnly: false @@ -78140,8 +79285,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -78149,7 +79294,7 @@ paths: application/json: schema: type: array - items: *238 + items: *241 examples: default: value: @@ -78180,8 +79325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -78193,7 +79338,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *238 + items: *241 required: - properties examples: @@ -78243,8 +79388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *304 - - *305 + - *309 + - *310 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -78304,9 +79449,9 @@ paths: application/json: schema: type: array - items: *542 + items: *552 examples: - default: *543 + default: *553 headers: Link: *58 '304': *37 @@ -78338,8 +79483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -78404,7 +79549,7 @@ paths: description: Response content: application/json: - schema: &547 + schema: &557 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -78515,8 +79660,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *439 - required: *440 + properties: *449 + required: *450 nullable: true active_lock_reason: type: string @@ -78561,7 +79706,7 @@ paths: nullable: true requested_teams: type: array - items: *282 + items: *287 nullable: true head: type: object @@ -78600,14 +79745,14 @@ paths: _links: type: object properties: - comments: *441 - commits: *441 - statuses: *441 - html: *441 - issue: *441 - review_comments: *441 - review_comment: *441 - self: *441 + comments: *451 + commits: *451 + statuses: *451 + html: *451 + issue: *451 + review_comments: *451 + review_comment: *451 + self: *451 required: - comments - commits @@ -78618,7 +79763,7 @@ paths: - review_comment - self author_association: *63 - auto_merge: *544 + auto_merge: *554 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -78710,7 +79855,7 @@ paths: - merged_by - review_comments examples: - default: &548 + default: &558 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -79237,8 +80382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: sort in: query required: false @@ -79267,9 +80412,9 @@ paths: application/json: schema: type: array - items: *545 + items: *555 examples: - default: &550 + default: &560 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -79346,17 +80491,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '200': description: Response content: application/json: - schema: *545 + schema: *555 examples: - default: &546 + default: &556 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -79431,8 +80576,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -79455,9 +80600,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *555 examples: - default: *546 + default: *556 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79473,8 +80618,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '204': @@ -79496,8 +80641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -79524,9 +80669,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 '404': *6 @@ -79547,8 +80692,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -79581,16 +80726,16 @@ paths: description: Reaction exists content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Reaction created content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -79612,10 +80757,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *304 - - *305 + - *309 + - *310 - *76 - - *300 + - *305 responses: '204': description: Response @@ -79658,9 +80803,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *304 - - *305 - - &549 + - *309 + - *310 + - &559 name: pull_number description: The number that identifies the pull request. in: path @@ -79673,9 +80818,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *547 + schema: *557 examples: - default: *548 + default: *558 '304': *37 '404': *6 '406': @@ -79683,7 +80828,7 @@ paths: content: application/json: schema: *3 - '500': *97 + '500': *100 '503': *65 x-github: githubCloudOnly: false @@ -79710,9 +80855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: false content: @@ -79754,9 +80899,9 @@ paths: description: Response content: application/json: - schema: *547 + schema: *557 examples: - default: *548 + default: *558 '422': *15 '403': *29 x-github: @@ -79778,9 +80923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: true content: @@ -79840,17 +80985,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '401': *25 '403': *29 '404': *6 @@ -79880,9 +81025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 - *87 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -79903,9 +81048,9 @@ paths: application/json: schema: type: array - items: *545 + items: *555 examples: - default: *550 + default: *560 headers: Link: *58 x-github: @@ -79938,9 +81083,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: true content: @@ -80045,7 +81190,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *555 examples: example-for-a-multi-line-comment: value: @@ -80133,9 +81278,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 - *76 requestBody: required: true @@ -80158,7 +81303,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *555 examples: default: value: @@ -80244,9 +81389,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 - *17 - *19 responses: @@ -80256,9 +81401,9 @@ paths: application/json: schema: type: array - items: *435 + items: *445 examples: - default: *551 + default: *561 headers: Link: *58 x-github: @@ -80288,9 +81433,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 - *17 - *19 responses: @@ -80300,7 +81445,7 @@ paths: application/json: schema: type: array - items: *450 + items: *460 examples: default: value: @@ -80318,7 +81463,7 @@ paths: headers: Link: *58 '422': *15 - '500': *97 + '500': *100 '503': *65 x-github: githubCloudOnly: false @@ -80338,9 +81483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 responses: '204': description: Response if pull request has been merged @@ -80363,9 +81508,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: false content: @@ -80476,9 +81621,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 responses: '200': description: Response @@ -80494,7 +81639,7 @@ paths: items: *4 teams: type: array - items: *155 + items: *158 required: - users - teams @@ -80553,9 +81698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: false content: @@ -80592,7 +81737,7 @@ paths: description: Response content: application/json: - schema: *542 + schema: *552 examples: default: value: @@ -81128,9 +82273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: true content: @@ -81164,7 +82309,7 @@ paths: description: Response content: application/json: - schema: *542 + schema: *552 examples: default: value: @@ -81669,9 +82814,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 - *17 - *19 responses: @@ -81681,7 +82826,7 @@ paths: application/json: schema: type: array - items: &552 + items: &562 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -81832,9 +82977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: false content: @@ -81920,9 +83065,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *562 examples: - default: &554 + default: &564 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -81985,10 +83130,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 - - &553 + - *309 + - *310 + - *559 + - &563 name: review_id description: The unique identifier of the review. in: path @@ -82000,9 +83145,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *562 examples: - default: &555 + default: &565 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -82061,10 +83206,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 - - *553 + - *309 + - *310 + - *559 + - *563 requestBody: required: true content: @@ -82087,7 +83232,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *562 examples: default: value: @@ -82149,18 +83294,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 - - *553 + - *309 + - *310 + - *559 + - *563 responses: '200': description: Response content: application/json: - schema: *552 + schema: *562 examples: - default: *554 + default: *564 '422': *7 '404': *6 x-github: @@ -82187,10 +83332,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *304 - - *305 - - *549 - - *553 + - *309 + - *310 + - *559 + - *563 - *17 - *19 responses: @@ -82273,9 +83418,9 @@ paths: _links: type: object properties: - self: *441 - html: *441 - pull_request: *441 + self: *451 + html: *451 + pull_request: *451 required: - self - html @@ -82425,10 +83570,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 - - *553 + - *309 + - *310 + - *559 + - *563 requestBody: required: true content: @@ -82456,7 +83601,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *562 examples: default: value: @@ -82519,10 +83664,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 - - *553 + - *309 + - *310 + - *559 + - *563 requestBody: required: true content: @@ -82557,9 +83702,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *562 examples: - default: *555 + default: *565 '404': *6 '422': *7 '403': *29 @@ -82581,9 +83726,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: false content: @@ -82646,8 +83791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *304 - - *305 + - *309 + - *310 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -82660,9 +83805,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *566 examples: - default: &557 + default: &567 value: type: file encoding: base64 @@ -82704,8 +83849,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *304 - - *305 + - *309 + - *310 - name: dir description: The alternate path to look for a README file in: path @@ -82725,9 +83870,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *566 examples: - default: *557 + default: *567 '404': *6 '422': *15 x-github: @@ -82749,8 +83894,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -82760,7 +83905,7 @@ paths: application/json: schema: type: array - items: &558 + items: &568 title: Release description: A release. type: object @@ -82827,7 +83972,7 @@ paths: author: *4 assets: type: array - items: &559 + items: &569 title: Release Asset description: Data related to a release. type: object @@ -83014,8 +84159,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -83091,9 +84236,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *568 examples: - default: &562 + default: &572 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -83198,9 +84343,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *304 - - *305 - - &560 + - *309 + - *310 + - &570 name: asset_id description: The unique identifier of the asset. in: path @@ -83212,9 +84357,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *569 examples: - default: &561 + default: &571 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -83249,7 +84394,7 @@ paths: type: User site_admin: false '404': *6 - '302': *452 + '302': *462 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83265,9 +84410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *304 - - *305 - - *560 + - *309 + - *310 + - *570 requestBody: required: false content: @@ -83295,9 +84440,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *569 examples: - default: *561 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83313,9 +84458,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *304 - - *305 - - *560 + - *309 + - *310 + - *570 responses: '204': description: Response @@ -83339,8 +84484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -83425,16 +84570,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *558 + schema: *568 examples: - default: *562 + default: *572 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83451,8 +84596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *304 - - *305 + - *309 + - *310 - name: tag description: tag parameter in: path @@ -83465,9 +84610,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *568 examples: - default: *562 + default: *572 '404': *6 x-github: githubCloudOnly: false @@ -83489,9 +84634,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *304 - - *305 - - &563 + - *309 + - *310 + - &573 name: release_id description: The unique identifier of the release. in: path @@ -83505,9 +84650,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *558 + schema: *568 examples: - default: *562 + default: *572 '401': description: Unauthorized x-github: @@ -83525,9 +84670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 requestBody: required: false content: @@ -83591,9 +84736,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *568 examples: - default: *562 + default: *572 '404': description: Not Found if the discussion category name is invalid content: @@ -83614,9 +84759,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 responses: '204': description: Response @@ -83636,9 +84781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 - *17 - *19 responses: @@ -83648,7 +84793,7 @@ paths: application/json: schema: type: array - items: *559 + items: *569 examples: default: value: @@ -83729,9 +84874,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 - name: name in: query required: true @@ -83757,7 +84902,7 @@ paths: description: Response for successful upload content: application/json: - schema: *559 + schema: *569 examples: response-for-successful-upload: value: @@ -83812,9 +84957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -83838,9 +84983,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 '404': *6 @@ -83861,9 +85006,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 requestBody: required: true content: @@ -83893,16 +85038,16 @@ paths: description: Reaction exists content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Reaction created content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -83924,10 +85069,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *304 + - *309 + - *310 + - *573 - *305 - - *563 - - *300 responses: '204': description: Response @@ -83951,9 +85096,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 - *17 - *19 responses: @@ -83969,8 +85114,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *247 - - &564 + - *250 + - &574 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -83989,66 +85134,66 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *248 - - *564 - - allOf: - - *249 - - *564 - - allOf: - - *250 - - *564 - - allOf: - - *565 - - *564 - allOf: - *251 - - *564 + - *574 - allOf: - *252 - - *564 + - *574 - allOf: - *253 - - *564 + - *574 + - allOf: + - *575 + - *574 - allOf: - *254 - - *564 + - *574 - allOf: - *255 - - *564 + - *574 - allOf: - *256 - - *564 + - *574 - allOf: - *257 - - *564 + - *574 - allOf: - *258 - - *564 + - *574 - allOf: - *259 - - *564 + - *574 - allOf: - *260 - - *564 + - *574 - allOf: - *261 - - *564 + - *574 - allOf: - *262 - - *564 + - *574 - allOf: - *263 - - *564 + - *574 - allOf: - *264 - - *564 + - *574 - allOf: - *265 - - *564 + - *574 - allOf: - *266 - - *564 + - *574 + - allOf: + - *267 + - *574 + - allOf: + - *268 + - *574 + - allOf: + - *269 + - *574 examples: default: value: @@ -84087,8 +85232,8 @@ paths: category: repos subcategory: rules parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 - name: includes_parents @@ -84099,7 +85244,7 @@ paths: schema: type: boolean default: true - - *566 + - *576 responses: '200': description: Response @@ -84107,7 +85252,7 @@ paths: application/json: schema: type: array - items: *267 + items: *270 examples: default: value: @@ -84138,7 +85283,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *97 + '500': *100 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -84154,8 +85299,8 @@ paths: category: repos subcategory: rules parameters: - - *304 - - *305 + - *309 + - *310 requestBody: description: Request body required: true @@ -84175,16 +85320,16 @@ paths: - tag - push default: branch - enforcement: *244 + enforcement: *247 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *245 - conditions: *242 + items: *248 + conditions: *245 rules: type: array description: An array of rules within the ruleset. - items: *567 + items: *577 required: - name - enforcement @@ -84215,9 +85360,9 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: &577 + default: &587 value: id: 42 name: super cool ruleset @@ -84250,7 +85395,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *97 + '500': *100 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -84264,12 +85409,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *304 - - *305 - - *568 - - *569 - - *570 - - *571 + - *309 + - *310 + - *578 + - *579 + - *580 + - *581 - *17 - *19 responses: @@ -84277,11 +85422,11 @@ paths: description: Response content: application/json: - schema: *572 + schema: *582 examples: - default: *573 + default: *583 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84300,19 +85445,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *304 - - *305 - - *574 + - *309 + - *310 + - *584 responses: '200': description: Response content: application/json: - schema: *575 + schema: *585 examples: - default: *576 + default: *586 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84338,8 +85483,8 @@ paths: category: repos subcategory: rules parameters: - - *304 - - *305 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84359,11 +85504,11 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: *577 + default: *587 '404': *6 - '500': *97 + '500': *100 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -84379,8 +85524,8 @@ paths: category: repos subcategory: rules parameters: - - *304 - - *305 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84405,16 +85550,16 @@ paths: - branch - tag - push - enforcement: *244 + enforcement: *247 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *245 - conditions: *242 + items: *248 + conditions: *245 rules: description: An array of rules within the ruleset. type: array - items: *567 + items: *577 examples: default: value: @@ -84442,11 +85587,11 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: *577 + default: *587 '404': *6 - '500': *97 + '500': *100 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -84462,8 +85607,8 @@ paths: category: repos subcategory: rules parameters: - - *304 - - *305 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84474,7 +85619,7 @@ paths: '204': description: Response '404': *6 - '500': *97 + '500': *100 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -84486,8 +85631,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 - name: ruleset_id @@ -84503,11 +85648,11 @@ paths: application/json: schema: type: array - items: *270 + items: *273 examples: - default: *578 + default: *588 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84524,8 +85669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *304 - - *305 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84543,7 +85688,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *589 examples: default: value: @@ -84576,7 +85721,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84598,21 +85743,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *304 - - *305 - - *271 - - *272 - - *273 + - *309 + - *310 - *274 - - *48 - - *19 - - *17 - - *580 - - *581 - *275 - *276 - *277 + - *48 + - *19 + - *17 + - *590 + - *591 - *278 + - *279 + - *280 + - *281 responses: '200': description: Response @@ -84620,7 +85765,7 @@ paths: application/json: schema: type: array - items: &585 + items: &595 type: object properties: number: *54 @@ -84639,8 +85784,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *582 - resolution: *583 + state: *592 + resolution: *593 resolved_at: type: string format: date-time @@ -84736,7 +85881,7 @@ paths: pull request. ' - oneOf: *584 + oneOf: *594 nullable: true has_more_locations: type: boolean @@ -84886,16 +86031,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *304 - - *305 - - *404 - - *278 + - *309 + - *310 + - *414 + - *281 responses: '200': description: Response content: application/json: - schema: *585 + schema: *595 examples: default: value: @@ -84947,9 +86092,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 requestBody: required: true content: @@ -84957,8 +86102,8 @@ paths: schema: type: object properties: - state: *582 - resolution: *583 + state: *592 + resolution: *593 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -84976,7 +86121,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *595 examples: default: value: @@ -85051,9 +86196,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 - *19 - *17 responses: @@ -85064,7 +86209,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &739 + items: &751 type: object properties: type: @@ -85090,19 +86235,19 @@ paths: example: commit details: oneOf: - - *586 - - *587 - - *588 - - *589 - - *590 - - *591 - - *592 - - *593 - - *594 - - *595 - *596 - *597 - *598 + - *599 + - *600 + - *601 + - *602 + - *603 + - *604 + - *605 + - *606 + - *607 + - *608 examples: default: value: @@ -85188,8 +86333,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -85197,14 +86342,14 @@ paths: schema: type: object properties: - reason: &600 + reason: &610 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *599 + placeholder_id: *609 required: - reason - placeholder_id @@ -85221,7 +86366,7 @@ paths: schema: type: object properties: - reason: *600 + reason: *610 expire_at: type: string format: date-time @@ -85264,8 +86409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -85280,7 +86425,7 @@ paths: properties: incremental_scans: type: array - items: &601 + items: &611 description: Information on a single scan performed by secret scanning on the repository type: object @@ -85306,15 +86451,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *601 + items: *611 backfill_scans: type: array - items: *601 + items: *611 custom_pattern_backfill_scans: type: array items: allOf: - - *601 + - *611 - type: object properties: pattern_name: @@ -85384,8 +86529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *304 - - *305 + - *309 + - *310 - *48 - name: sort description: The property to sort the results by. @@ -85429,9 +86574,9 @@ paths: application/json: schema: type: array - items: *602 + items: *612 examples: - default: *603 + default: *613 '400': *14 '404': *6 x-github: @@ -85454,8 +86599,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -85528,7 +86673,7 @@ paths: login: type: string description: The username of the user credited. - type: *281 + type: *286 required: - login - type @@ -85615,9 +86760,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *612 examples: - default: &605 + default: &615 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -85850,8 +86995,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -85955,7 +87100,7 @@ paths: description: Response content: application/json: - schema: *602 + schema: *612 examples: default: value: @@ -86102,17 +87247,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *304 - - *305 - - *604 + - *309 + - *310 + - *614 responses: '200': description: Response content: application/json: - schema: *602 + schema: *612 examples: - default: *605 + default: *615 '403': *29 '404': *6 x-github: @@ -86136,9 +87281,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *304 - - *305 - - *604 + - *309 + - *310 + - *614 requestBody: required: true content: @@ -86211,7 +87356,7 @@ paths: login: type: string description: The username of the user credited. - type: *281 + type: *286 required: - login - type @@ -86297,17 +87442,17 @@ paths: description: Response content: application/json: - schema: *602 + schema: *612 examples: - default: *605 - add_credit: *605 + default: *615 + add_credit: *615 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *100 + schema: *103 examples: invalid_state_transition: value: @@ -86338,9 +87483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *304 - - *305 - - *604 + - *309 + - *310 + - *614 responses: '202': *39 '400': *14 @@ -86367,17 +87512,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *304 - - *305 - - *604 + - *309 + - *310 + - *614 responses: '202': description: Response content: application/json: - schema: *315 + schema: *320 examples: - default: *317 + default: *322 '400': *14 '422': *15 '403': *29 @@ -86403,8 +87548,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -86503,8 +87648,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -86513,7 +87658,7 @@ paths: application/json: schema: type: array - items: &606 + items: &616 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -86526,7 +87671,7 @@ paths: - 1124 - -435 '202': *39 - '204': *149 + '204': *152 '422': description: Repository contains more than 10,000 commits x-github: @@ -86546,8 +87691,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -86596,7 +87741,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *149 + '204': *152 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86623,8 +87768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -86698,7 +87843,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *149 + '204': *152 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86720,8 +87865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -86875,8 +88020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -86886,7 +88031,7 @@ paths: application/json: schema: type: array - items: *606 + items: *616 examples: default: value: @@ -86899,7 +88044,7 @@ paths: - - 0 - 2 - 21 - '204': *149 + '204': *152 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86919,8 +88064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *304 - - *305 + - *309 + - *310 - name: sha in: path required: true @@ -86974,7 +88119,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *617 examples: default: value: @@ -87028,8 +88173,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -87041,7 +88186,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -87061,14 +88206,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &608 + schema: &618 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -87136,8 +88281,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -87163,7 +88308,7 @@ paths: description: Response content: application/json: - schema: *608 + schema: *618 examples: default: value: @@ -87190,8 +88335,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -87211,8 +88356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -87291,8 +88436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -87300,7 +88445,7 @@ paths: application/json: schema: type: array - items: &609 + items: &619 title: Tag protection description: Tag protection type: object @@ -87352,8 +88497,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -87376,7 +88521,7 @@ paths: description: Response content: application/json: - schema: *609 + schema: *619 examples: default: value: @@ -87407,8 +88552,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -87445,8 +88590,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *304 - - *305 + - *309 + - *310 - name: ref in: path required: true @@ -87482,8 +88627,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -87493,9 +88638,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 headers: Link: *58 '404': *6 @@ -87515,8 +88660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *304 - - *305 + - *309 + - *310 - *19 - *17 responses: @@ -87524,7 +88669,7 @@ paths: description: Response content: application/json: - schema: &610 + schema: &620 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -87536,7 +88681,7 @@ paths: required: - names examples: - default: &611 + default: &621 value: names: - octocat @@ -87559,8 +88704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -87591,9 +88736,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *620 examples: - default: *611 + default: *621 '404': *6 '422': *7 x-github: @@ -87614,9 +88759,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *304 - - *305 - - &612 + - *309 + - *310 + - &622 name: per description: The time frame to display results for. in: query @@ -87645,7 +88790,7 @@ paths: example: 128 clones: type: array - items: &613 + items: &623 title: Traffic type: object properties: @@ -87732,8 +88877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -87823,8 +88968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -87884,9 +89029,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *304 - - *305 - - *612 + - *309 + - *310 + - *622 responses: '200': description: Response @@ -87905,7 +89050,7 @@ paths: example: 3782 views: type: array - items: *613 + items: *623 required: - uniques - count @@ -87982,8 +89127,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -88019,7 +89164,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *125 examples: default: value: @@ -88257,8 +89402,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -88281,8 +89426,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -88304,8 +89449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -88331,8 +89476,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *304 - - *305 + - *309 + - *310 - name: ref in: path required: true @@ -88424,9 +89569,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *320 examples: - default: *317 + default: *322 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -88467,7 +89612,7 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: default: value: @@ -88656,7 +89801,7 @@ paths: html_url: type: string format: uri - repository: *122 + repository: *125 score: type: number file_size: @@ -88674,7 +89819,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &614 + text_matches: &624 title: Search Result Text Matches type: array items: @@ -88836,7 +89981,7 @@ paths: enum: - author-date - committer-date - - &615 + - &625 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -88907,7 +90052,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *370 + properties: *380 nullable: true comment_count: type: integer @@ -88927,7 +90072,7 @@ paths: url: type: string format: uri - verification: *487 + verification: *497 required: - author - committer @@ -88946,7 +90091,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *370 + properties: *380 nullable: true parents: type: array @@ -88959,12 +90104,12 @@ paths: type: string sha: type: string - repository: *122 + repository: *125 score: type: number node_id: type: string - text_matches: *614 + text_matches: *624 required: - sha - node_id @@ -89146,7 +90291,7 @@ paths: - interactions - created - updated - - *615 + - *625 - *17 - *19 - name: advanced_search @@ -89243,7 +90388,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: type: string state_reason: @@ -89260,8 +90406,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *439 - required: *440 + properties: *449 + required: *450 nullable: true comments: type: integer @@ -89275,7 +90421,7 @@ paths: type: string format: date-time nullable: true - text_matches: *614 + text_matches: *624 pull_request: type: object properties: @@ -89319,7 +90465,7 @@ paths: timeline_url: type: string format: uri - type: *196 + type: *199 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -89503,7 +90649,7 @@ paths: enum: - created - updated - - *615 + - *625 - *17 - *19 responses: @@ -89547,7 +90693,7 @@ paths: nullable: true score: type: number - text_matches: *614 + text_matches: *624 required: - id - node_id @@ -89632,7 +90778,7 @@ paths: - forks - help-wanted-issues - updated - - *615 + - *625 - *17 - *19 responses: @@ -89871,7 +91017,7 @@ paths: - admin - pull - push - text_matches: *614 + text_matches: *624 temp_clone_token: type: string allow_merge_commit: @@ -90171,7 +91317,7 @@ paths: type: string format: uri nullable: true - text_matches: *614 + text_matches: *624 related: type: array nullable: true @@ -90362,7 +91508,7 @@ paths: - followers - repositories - joined - - *615 + - *625 - *17 - *19 responses: @@ -90466,7 +91612,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *614 + text_matches: *624 blog: type: string nullable: true @@ -90545,7 +91691,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &617 + - &628 name: team_id description: The unique identifier of the team. in: path @@ -90557,9 +91703,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '404': *6 x-github: githubCloudOnly: false @@ -90586,7 +91732,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *617 + - *628 requestBody: required: true content: @@ -90649,16 +91795,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '201': description: Response content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '404': *6 '422': *15 '403': *29 @@ -90686,7 +91832,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *617 + - *628 responses: '204': description: Response @@ -90717,7 +91863,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *617 + - *628 - *48 - *17 - *19 @@ -90728,9 +91874,9 @@ paths: application/json: schema: type: array - items: *291 + items: *296 examples: - default: *618 + default: *629 headers: Link: *58 x-github: @@ -90759,7 +91905,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *617 + - *628 requestBody: required: true content: @@ -90793,9 +91939,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *292 + default: *297 x-github: triggersNotification: true githubCloudOnly: false @@ -90822,16 +91968,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *617 - - *293 + - *628 + - *298 responses: '200': description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *292 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90856,8 +92002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *617 - - *293 + - *628 + - *298 requestBody: required: false content: @@ -90880,9 +92026,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *619 + default: *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90907,8 +92053,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *617 - - *293 + - *628 + - *298 responses: '204': description: Response @@ -90937,8 +92083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *617 - - *293 + - *628 + - *298 - *48 - *17 - *19 @@ -90949,9 +92095,9 @@ paths: application/json: schema: type: array - items: *294 + items: *299 examples: - default: *620 + default: *631 headers: Link: *58 x-github: @@ -90980,8 +92126,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *617 - - *293 + - *628 + - *298 requestBody: required: true content: @@ -91003,9 +92149,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: *295 + default: *300 x-github: triggersNotification: true githubCloudOnly: false @@ -91032,17 +92178,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *617 - - *293 - - *296 + - *628 + - *298 + - *301 responses: '200': description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: *295 + default: *300 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91067,9 +92213,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *617 - - *293 - - *296 + - *628 + - *298 + - *301 requestBody: required: true content: @@ -91091,9 +92237,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: *621 + default: *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91118,9 +92264,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *617 - - *293 - - *296 + - *628 + - *298 + - *301 responses: '204': description: Response @@ -91149,9 +92295,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *617 - - *293 - - *296 + - *628 + - *298 + - *301 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -91177,9 +92323,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 x-github: @@ -91208,9 +92354,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *617 - - *293 - - *296 + - *628 + - *298 + - *301 requestBody: required: true content: @@ -91242,9 +92388,9 @@ paths: description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91270,8 +92416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *617 - - *293 + - *628 + - *298 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -91297,9 +92443,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 x-github: @@ -91328,8 +92474,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *617 - - *293 + - *628 + - *298 requestBody: required: true content: @@ -91361,9 +92507,9 @@ paths: description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -91387,7 +92533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *617 + - *628 - *17 - *19 responses: @@ -91397,9 +92543,9 @@ paths: application/json: schema: type: array - items: *193 + items: *196 examples: - default: *194 + default: *197 headers: Link: *58 x-github: @@ -91425,7 +92571,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *617 + - *628 - name: role description: Filters members returned by their role in the team. in: query @@ -91448,7 +92594,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '404': *6 @@ -91476,8 +92622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *617 - - *135 + - *628 + - *138 responses: '204': description: if user is a member @@ -91513,8 +92659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *617 - - *135 + - *628 + - *138 responses: '204': description: Response @@ -91553,8 +92699,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *617 - - *135 + - *628 + - *138 responses: '204': description: Response @@ -91590,16 +92736,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *617 - - *135 + - *628 + - *138 responses: '200': description: Response content: application/json: - schema: *301 + schema: *306 examples: - response-if-user-is-a-team-maintainer: *622 + response-if-user-is-a-team-maintainer: *633 '404': *6 x-github: githubCloudOnly: false @@ -91632,8 +92778,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *617 - - *135 + - *628 + - *138 requestBody: required: false content: @@ -91658,9 +92804,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *306 examples: - response-if-users-membership-with-team-is-now-pending: *623 + response-if-users-membership-with-team-is-now-pending: *634 '403': description: Forbidden if team synchronization is set up '422': @@ -91694,8 +92840,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *617 - - *135 + - *628 + - *138 responses: '204': description: Response @@ -91723,7 +92869,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *617 + - *628 - *17 - *19 responses: @@ -91733,9 +92879,9 @@ paths: application/json: schema: type: array - items: *302 + items: *307 examples: - default: *624 + default: *635 headers: Link: *58 '404': *6 @@ -91761,16 +92907,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *617 - - *303 + - *628 + - *308 responses: '200': description: Response content: application/json: - schema: *302 + schema: *307 examples: - default: *625 + default: *636 '404': description: Not Found if project is not managed by this team x-github: @@ -91794,8 +92940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *617 - - *303 + - *628 + - *308 requestBody: required: false content: @@ -91862,8 +93008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *617 - - *303 + - *628 + - *308 responses: '204': description: Response @@ -91890,7 +93036,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *617 + - *628 - *17 - *19 responses: @@ -91900,9 +93046,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 '404': *6 @@ -91932,15 +93078,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *617 - - *304 - - *305 + - *628 + - *309 + - *310 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *626 + schema: *637 examples: alternative-response-with-extra-repository-information: value: @@ -92091,9 +93237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *617 - - *304 - - *305 + - *628 + - *309 + - *310 requestBody: required: false content: @@ -92143,9 +93289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *617 - - *304 - - *305 + - *628 + - *309 + - *310 responses: '204': description: Response @@ -92170,7 +93316,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *617 + - *628 - *17 - *19 responses: @@ -92180,9 +93326,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - response-if-child-teams-exist: *627 + response-if-child-teams-exist: *638 headers: Link: *58 '404': *6 @@ -92215,7 +93361,7 @@ paths: application/json: schema: oneOf: - - &629 + - &640 title: Private User description: Private User type: object @@ -92418,7 +93564,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *628 + - *639 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -92571,7 +93717,7 @@ paths: description: Response content: application/json: - schema: *629 + schema: *640 examples: default: value: @@ -92650,7 +93796,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '304': *37 '404': *6 '403': *29 @@ -92673,7 +93819,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *135 + - *138 responses: '204': description: If the user is blocked @@ -92701,7 +93847,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *135 + - *138 responses: '204': description: Response @@ -92725,7 +93871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *135 + - *138 responses: '204': description: Response @@ -92774,11 +93920,11 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: - default: *203 + default: *206 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -92915,17 +94061,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '401': *25 '403': *29 '404': *6 @@ -92969,7 +94115,7 @@ paths: type: integer secrets: type: array - items: &630 + items: &641 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -93009,7 +94155,7 @@ paths: - visibility - selected_repositories_url examples: - default: *427 + default: *437 headers: Link: *58 x-github: @@ -93079,13 +94225,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *130 + - *133 responses: '200': description: Response content: application/json: - schema: *630 + schema: *641 examples: default: value: @@ -93115,7 +94261,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *130 + - *133 requestBody: required: true content: @@ -93160,7 +94306,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -93188,7 +94334,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *130 + - *133 responses: '204': description: Response @@ -93213,7 +94359,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *130 + - *133 responses: '200': description: Response @@ -93229,13 +94375,13 @@ paths: type: integer repositories: type: array - items: *122 + items: *125 examples: - default: *631 + default: *642 '401': *25 '403': *29 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93256,7 +94402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *130 + - *133 requestBody: required: true content: @@ -93288,7 +94434,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93310,7 +94456,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *130 + - *133 - name: repository_id in: path required: true @@ -93322,7 +94468,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93343,7 +94489,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *130 + - *133 - name: repository_id in: path required: true @@ -93355,7 +94501,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93375,17 +94521,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -93409,7 +94555,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 requestBody: required: false content: @@ -93439,9 +94585,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '401': *25 '403': *29 '404': *6 @@ -93463,11 +94609,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: '202': *39 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -93492,13 +94638,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: '202': description: Response content: application/json: - schema: &632 + schema: &643 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -93539,7 +94685,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &633 + default: &644 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -93547,7 +94693,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -93571,7 +94717,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *204 + - *207 - name: export_id in: path required: true @@ -93584,9 +94730,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *643 examples: - default: *633 + default: *644 '404': *6 x-github: githubCloudOnly: false @@ -93607,7 +94753,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *204 + - *207 responses: '200': description: Response @@ -93623,11 +94769,11 @@ paths: type: integer machines: type: array - items: *634 + items: *645 examples: - default: *635 + default: *646 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -93654,7 +94800,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *204 + - *207 requestBody: required: true content: @@ -93704,13 +94850,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *315 + repository: *320 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *425 - required: *426 + properties: *435 + required: *436 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -94484,17 +95630,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '304': *37 - '500': *97 + '500': *100 '400': *14 '401': *25 '402': @@ -94524,16 +95670,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *424 - '500': *97 + default: *434 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -94562,9 +95708,9 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: &648 + default: &658 value: - id: 197 name: hello_docker @@ -94665,7 +95811,7 @@ paths: application/json: schema: type: array - items: &636 + items: &647 title: Email description: Email type: object @@ -94730,9 +95876,9 @@ paths: application/json: schema: type: array - items: *636 + items: *647 examples: - default: &650 + default: &660 value: - email: octocat@github.com verified: true @@ -94807,7 +95953,7 @@ paths: application/json: schema: type: array - items: *636 + items: *647 examples: default: value: @@ -94917,7 +96063,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '304': *37 @@ -94950,7 +96096,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '304': *37 @@ -94972,7 +96118,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *135 + - *138 responses: '204': description: if the person is followed by the authenticated user @@ -95002,7 +96148,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *135 + - *138 responses: '204': description: Response @@ -95027,7 +96173,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *135 + - *138 responses: '204': description: Response @@ -95063,7 +96209,7 @@ paths: application/json: schema: type: array - items: &637 + items: &648 title: GPG Key description: A unique encryption key type: object @@ -95194,7 +96340,7 @@ paths: - subkeys - revoked examples: - default: &664 + default: &674 value: - id: 3 name: Octocat's GPG Key @@ -95279,9 +96425,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *648 examples: - default: &638 + default: &649 value: id: 3 name: Octocat's GPG Key @@ -95338,7 +96484,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &639 + - &650 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -95350,9 +96496,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *648 examples: - default: *638 + default: *649 '404': *6 '304': *37 '403': *29 @@ -95375,7 +96521,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *639 + - *650 responses: '204': description: Response @@ -95566,7 +96712,7 @@ paths: type: array items: *60 examples: - default: *640 + default: *115 headers: Link: *58 '404': *6 @@ -95591,7 +96737,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *112 + - *97 responses: '204': description: Response @@ -95617,7 +96763,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *112 + - *97 responses: '204': description: Response @@ -95651,12 +96797,12 @@ paths: application/json: schema: anyOf: - - *191 + - *194 - type: object properties: {} additionalProperties: false examples: - default: *192 + default: *195 '204': description: Response when there are no restrictions x-github: @@ -95680,7 +96826,7 @@ paths: required: true content: application/json: - schema: *498 + schema: *508 examples: default: value: @@ -95691,7 +96837,7 @@ paths: description: Response content: application/json: - schema: *191 + schema: *194 examples: default: value: @@ -95772,7 +96918,7 @@ paths: - closed - all default: open - - *199 + - *202 - name: sort description: What to sort results by. in: query @@ -95797,7 +96943,7 @@ paths: type: array items: *77 examples: - default: *200 + default: *203 headers: Link: *58 '404': *6 @@ -95830,7 +96976,7 @@ paths: application/json: schema: type: array - items: &641 + items: &651 title: Key description: Key type: object @@ -95931,9 +97077,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *651 examples: - default: &642 + default: &652 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -95966,15 +97112,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *527 + - *537 responses: '200': description: Response content: application/json: - schema: *641 + schema: *651 examples: - default: *642 + default: *652 '404': *6 '304': *37 '403': *29 @@ -95997,7 +97143,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *527 + - *537 responses: '204': description: Response @@ -96030,7 +97176,7 @@ paths: application/json: schema: type: array - items: &643 + items: &653 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -96098,7 +97244,7 @@ paths: - account - plan examples: - default: &644 + default: &654 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -96160,9 +97306,9 @@ paths: application/json: schema: type: array - items: *643 + items: *653 examples: - default: *644 + default: *654 headers: Link: *58 '304': *37 @@ -96202,7 +97348,7 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: default: value: @@ -96304,13 +97450,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -96368,7 +97514,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *96 + - *94 requestBody: required: true content: @@ -96393,7 +97539,7 @@ paths: description: Response content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -96461,7 +97607,7 @@ paths: application/json: schema: type: array - items: *209 + items: *212 examples: default: value: @@ -96714,7 +97860,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -96894,7 +98040,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *210 + - *213 - name: exclude in: query required: false @@ -96907,7 +98053,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -97101,7 +98247,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *210 + - *213 responses: '302': description: Response @@ -97127,7 +98273,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *210 + - *213 responses: '204': description: Response @@ -97156,8 +98302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *210 - - *645 + - *213 + - *655 responses: '204': description: Response @@ -97181,7 +98327,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *210 + - *213 - *17 - *19 responses: @@ -97191,9 +98337,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 '404': *6 @@ -97228,9 +98374,9 @@ paths: application/json: schema: type: array - items: *206 + items: *209 examples: - default: *646 + default: *656 headers: Link: *58 '304': *37 @@ -97272,7 +98418,7 @@ paths: - docker - nuget - container - - *647 + - *657 - *19 - *17 responses: @@ -97282,10 +98428,10 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: *648 - '400': *649 + default: *658 + '400': *659 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97305,16 +98451,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *219 - - *220 + - *222 + - *223 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: &665 + default: &675 value: id: 40201 name: octo-name @@ -97427,8 +98573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *219 - - *220 + - *222 + - *223 responses: '204': description: Response @@ -97458,8 +98604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *219 - - *220 + - *222 + - *223 - name: token description: package token schema: @@ -97491,8 +98637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *219 - - *220 + - *222 + - *223 - *19 - *17 - name: state @@ -97512,7 +98658,7 @@ paths: application/json: schema: type: array - items: *221 + items: *224 examples: default: value: @@ -97561,15 +98707,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *219 - - *220 - *222 + - *223 + - *225 responses: '200': description: Response content: application/json: - schema: *221 + schema: *224 examples: default: value: @@ -97605,9 +98751,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *219 - - *220 - *222 + - *223 + - *225 responses: '204': description: Response @@ -97637,9 +98783,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *219 - - *220 - *222 + - *223 + - *225 responses: '204': description: Response @@ -97695,7 +98841,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: default: value: @@ -97767,9 +98913,9 @@ paths: application/json: schema: type: array - items: *636 + items: *647 examples: - default: *650 + default: *660 headers: Link: *58 '304': *37 @@ -97882,7 +99028,7 @@ paths: type: array items: *60 examples: - default: &657 + default: &667 summary: Default response value: - id: 1296269 @@ -98186,9 +99332,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *320 examples: - default: *317 + default: *322 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -98226,9 +99372,9 @@ paths: application/json: schema: type: array - items: *500 + items: *510 examples: - default: *651 + default: *661 headers: Link: *58 '304': *37 @@ -98251,7 +99397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *195 + - *198 responses: '204': description: Response @@ -98274,7 +99420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *195 + - *198 responses: '204': description: Response @@ -98307,7 +99453,7 @@ paths: application/json: schema: type: array - items: &652 + items: &662 title: Social account description: Social media account type: object @@ -98322,7 +99468,7 @@ paths: - provider - url examples: - default: &653 + default: &663 value: - provider: twitter url: https://twitter.com/github @@ -98384,9 +99530,9 @@ paths: application/json: schema: type: array - items: *652 + items: *662 examples: - default: *653 + default: *663 '422': *15 '304': *37 '404': *6 @@ -98473,7 +99619,7 @@ paths: application/json: schema: type: array - items: &654 + items: &664 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -98493,7 +99639,7 @@ paths: - title - created_at examples: - default: &676 + default: &686 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -98559,9 +99705,9 @@ paths: description: Response content: application/json: - schema: *654 + schema: *664 examples: - default: &655 + default: &665 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -98592,7 +99738,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &656 + - &666 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -98604,9 +99750,9 @@ paths: description: Response content: application/json: - schema: *654 + schema: *664 examples: - default: *655 + default: *665 '404': *6 '304': *37 '403': *29 @@ -98629,7 +99775,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *656 + - *666 responses: '204': description: Response @@ -98658,7 +99804,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &677 + - &687 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -98683,11 +99829,11 @@ paths: type: array items: *60 examples: - default-response: *657 + default-response: *667 application/vnd.github.v3.star+json: schema: type: array - items: &678 + items: &688 title: Starred Repository description: Starred Repository type: object @@ -98843,8 +99989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response if this repository is starred by you @@ -98872,8 +100018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -98897,8 +100043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -98931,9 +100077,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 '304': *37 @@ -98970,7 +100116,7 @@ paths: application/json: schema: type: array - items: *289 + items: *294 examples: default: value: @@ -99056,10 +100202,10 @@ paths: application/json: schema: oneOf: - - *629 - - *628 + - *640 + - *639 examples: - default-response: &659 + default-response: &669 summary: Default response value: login: octocat @@ -99094,7 +100240,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &660 + response-with-git-hub-plan-information: &670 summary: Response with GitHub plan information value: login: octocat @@ -99154,7 +100300,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *658 + - *668 - *17 responses: '200': @@ -99165,7 +100311,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: example: ; rel="next" @@ -99195,7 +100341,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *135 + - *138 responses: '200': description: Response @@ -99203,11 +100349,11 @@ paths: application/json: schema: oneOf: - - *629 - - *628 + - *640 + - *639 examples: - default-response: *659 - response-with-git-hub-plan-information: *660 + default-response: *669 + response-with-git-hub-plan-information: *670 '404': *6 x-github: githubCloudOnly: false @@ -99233,7 +100379,7 @@ paths: - *17 - *40 - *41 - - *135 + - *138 requestBody: required: true content: @@ -99256,8 +100402,8 @@ paths: required: - subject_digests examples: - default: *661 - withPredicateType: *662 + default: *671 + withPredicateType: *672 responses: '200': description: Response @@ -99310,7 +100456,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *663 + default: *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99328,7 +100474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *135 + - *138 requestBody: required: true content: @@ -99393,7 +100539,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *135 + - *138 - name: subject_digest description: Subject Digest in: path @@ -99424,7 +100570,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *135 + - *138 - name: attestation_id description: Attestation ID in: path @@ -99462,7 +100608,7 @@ paths: - *17 - *40 - *41 - - *135 + - *138 - name: subject_digest description: Subject Digest in: path @@ -99512,12 +100658,12 @@ paths: bundle_url: type: string examples: - default: *366 + default: *376 '201': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -99543,7 +100689,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *135 + - *138 responses: '200': description: Response @@ -99551,9 +100697,9 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: *648 + default: *658 '403': *29 '401': *25 x-github: @@ -99576,7 +100722,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -99657,8 +100803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *135 - - *96 + - *138 + - *94 - *17 - *19 responses: @@ -99747,7 +100893,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -99824,7 +100970,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -99836,7 +100982,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -99855,7 +101001,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *135 + - *138 - *17 - *19 responses: @@ -99867,7 +101013,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -99886,7 +101032,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *135 + - *138 - name: target_user in: path required: true @@ -99913,7 +101059,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *135 + - *138 - *67 - *17 - *19 @@ -99947,7 +101093,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -99957,9 +101103,9 @@ paths: application/json: schema: type: array - items: *637 + items: *648 examples: - default: *664 + default: *674 headers: Link: *58 x-github: @@ -99983,7 +101129,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *135 + - *138 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -100055,7 +101201,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *135 + - *138 responses: '200': description: Response @@ -100063,7 +101209,7 @@ paths: application/json: schema: *22 examples: - default: *497 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100081,7 +101227,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -100136,7 +101282,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -100146,9 +101292,9 @@ paths: application/json: schema: type: array - items: *206 + items: *209 examples: - default: *646 + default: *656 headers: Link: *58 x-github: @@ -100187,8 +101333,8 @@ paths: - docker - nuget - container - - *647 - - *135 + - *657 + - *138 - *19 - *17 responses: @@ -100198,12 +101344,12 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: *648 + default: *658 '403': *29 '401': *25 - '400': *649 + '400': *659 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100223,17 +101369,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *219 - - *220 - - *135 + - *222 + - *223 + - *138 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: *665 + default: *675 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100254,9 +101400,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *219 - - *220 - - *135 + - *222 + - *223 + - *138 responses: '204': description: Response @@ -100288,9 +101434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *219 - - *220 - - *135 + - *222 + - *223 + - *138 - name: token description: package token schema: @@ -100322,9 +101468,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *219 - - *220 - - *135 + - *222 + - *223 + - *138 responses: '200': description: Response @@ -100332,7 +101478,7 @@ paths: application/json: schema: type: array - items: *221 + items: *224 examples: default: value: @@ -100390,16 +101536,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *219 - - *220 - *222 - - *135 + - *223 + - *225 + - *138 responses: '200': description: Response content: application/json: - schema: *221 + schema: *224 examples: default: value: @@ -100434,10 +101580,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *219 - - *220 - - *135 - *222 + - *223 + - *138 + - *225 responses: '204': description: Response @@ -100469,10 +101615,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *219 - - *220 - - *135 - *222 + - *223 + - *138 + - *225 responses: '204': description: Response @@ -100498,7 +101644,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-user-projects parameters: - - *135 + - *138 - name: state description: Indicates the state of the projects to return. in: query @@ -100519,7 +101665,7 @@ paths: application/json: schema: type: array - items: *233 + items: *236 examples: default: value: @@ -100581,7 +101727,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -100670,7 +101816,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -100757,7 +101903,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *135 + - *138 - name: type description: Limit results to repositories of the specified type. in: query @@ -100800,9 +101946,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -100826,15 +101972,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *135 + - *138 responses: '200': description: Response content: application/json: - schema: *666 + schema: *676 examples: - default: *667 + default: *677 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100856,15 +102002,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *135 + - *138 responses: '200': description: Response content: application/json: - schema: *668 + schema: *678 examples: - default: *669 + default: *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100886,15 +102032,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *135 + - *138 responses: '200': description: Response content: application/json: - schema: *670 + schema: *680 examples: - default: *671 + default: *681 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100914,11 +102060,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *135 - - *672 - - *673 - - *674 - - *675 + - *138 + - *682 + - *683 + - *684 + - *685 responses: '200': description: Response when getting a billing usage report @@ -100988,7 +102134,7 @@ paths: repositoryName: user/example '400': *14 '403': *29 - '500': *97 + '500': *100 '503': *65 x-github: githubCloudOnly: false @@ -101007,7 +102153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -101017,9 +102163,9 @@ paths: application/json: schema: type: array - items: *652 + items: *662 examples: - default: *653 + default: *663 headers: Link: *58 x-github: @@ -101039,7 +102185,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -101049,9 +102195,9 @@ paths: application/json: schema: type: array - items: *654 + items: *664 examples: - default: *676 + default: *686 headers: Link: *58 x-github: @@ -101075,8 +102221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *135 - - *677 + - *138 + - *687 - *48 - *17 - *19 @@ -101088,11 +102234,11 @@ paths: schema: anyOf: - type: array - items: *678 + items: *688 - type: array items: *60 examples: - default-response: *657 + default-response: *667 headers: Link: *58 x-github: @@ -101111,7 +102257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -101121,9 +102267,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -101251,7 +102397,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &679 + enterprise: &689 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -101309,7 +102455,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &680 + installation: &690 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -101328,7 +102474,7 @@ x-webhooks: required: - id - node_id - organization: &681 + organization: &691 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -101388,13 +102534,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &682 + repository: &692 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &712 + properties: &722 id: description: Unique identifier of the repository example: 42 @@ -102077,7 +103223,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &713 + required: &723 - archive_url - assignees_url - blobs_url @@ -102228,10 +103374,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -102307,11 +103453,11 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - rule: &683 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + rule: &693 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -102534,11 +103680,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - rule: *683 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + rule: *693 sender: *4 required: - action @@ -102721,11 +103867,11 @@ x-webhooks: - everyone required: - from - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - rule: *683 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + rule: *693 sender: *4 required: - action @@ -102809,7 +103955,7 @@ x-webhooks: type: string enum: - completed - check_run: &685 + check_run: &695 title: CheckRun description: A check performed on the code of a given code change type: object @@ -102862,8 +104008,8 @@ x-webhooks: type: string pull_requests: type: array - items: *383 - repository: *122 + items: *393 + repository: *125 status: example: completed type: string @@ -102900,7 +104046,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *684 + deployment: *694 details_url: example: https://example.com type: string @@ -102950,7 +104096,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *383 + items: *393 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -102985,9 +104131,9 @@ x-webhooks: - output - app - pull_requests - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - check_run @@ -103380,10 +104526,10 @@ x-webhooks: type: string enum: - created - check_run: *685 - installation: *680 - organization: *681 - repository: *682 + check_run: *695 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - check_run @@ -103779,10 +104925,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *685 - installation: *680 - organization: *681 - repository: *682 + check_run: *695 + installation: *690 + organization: *691 + repository: *692 requested_action: description: The action requested by the user. type: object @@ -104187,10 +105333,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *685 - installation: *680 - organization: *681 - repository: *682 + check_run: *695 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - check_run @@ -105167,10 +106313,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -105840,10 +106986,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -106507,10 +107653,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -106673,7 +107819,7 @@ x-webhooks: required: - login - id - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -106818,20 +107964,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &686 + commit_oid: &696 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *679 - installation: *680 - organization: *681 - ref: &687 + enterprise: *689 + installation: *690 + organization: *691 + ref: &697 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *682 + repository: *692 sender: *4 required: - action @@ -106993,7 +108139,7 @@ x-webhooks: required: - login - id - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -107223,12 +108369,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *686 - enterprise: *679 - installation: *680 - organization: *681 - ref: *687 - repository: *682 + commit_oid: *696 + enterprise: *689 + installation: *690 + organization: *691 + ref: *697 + repository: *692 sender: *4 required: - action @@ -107323,7 +108469,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -107491,12 +108637,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *686 - enterprise: *679 - installation: *680 - organization: *681 - ref: *687 - repository: *682 + commit_oid: *696 + enterprise: *689 + installation: *690 + organization: *691 + ref: *697 + repository: *692 sender: *4 required: - action @@ -107659,7 +108805,7 @@ x-webhooks: required: - login - id - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -107825,12 +108971,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *686 - enterprise: *679 - installation: *680 - organization: *681 - ref: *687 - repository: *682 + commit_oid: *696 + enterprise: *689 + installation: *690 + organization: *691 + ref: *697 + repository: *692 sender: *4 required: - action @@ -107927,7 +109073,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -108095,16 +109241,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *682 + repository: *692 sender: *4 required: - action @@ -108198,7 +109344,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -108338,12 +109484,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *686 - enterprise: *679 - installation: *680 - organization: *681 - ref: *687 - repository: *682 + commit_oid: *696 + enterprise: *689 + installation: *690 + organization: *691 + ref: *697 + repository: *692 sender: *4 required: - action @@ -108600,10 +109746,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -108683,18 +109829,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *681 - pusher_type: &688 + organization: *691 + pusher_type: &698 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &689 + ref: &699 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -108704,7 +109850,7 @@ x-webhooks: enum: - tag - branch - repository: *682 + repository: *692 sender: *4 required: - ref @@ -108786,10 +109932,10 @@ x-webhooks: type: string enum: - created - definition: *234 - enterprise: *679 - installation: *680 - organization: *681 + definition: *237 + enterprise: *689 + installation: *690 + organization: *691 sender: *4 required: - action @@ -108874,9 +110020,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 sender: *4 required: - action @@ -108953,10 +110099,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *234 - enterprise: *679 - installation: *680 - organization: *681 + definition: *237 + enterprise: *689 + installation: *690 + organization: *691 sender: *4 required: - action @@ -109033,10 +110179,10 @@ x-webhooks: type: string enum: - updated - definition: *234 - enterprise: *679 - installation: *680 - organization: *681 + definition: *237 + enterprise: *689 + installation: *690 + organization: *691 sender: *4 required: - action @@ -109113,19 +110259,19 @@ x-webhooks: type: string enum: - updated - enterprise: *679 - installation: *680 - repository: *682 - organization: *681 + enterprise: *689 + installation: *690 + repository: *692 + organization: *691 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *238 + items: *241 old_property_values: type: array description: The old custom property values for the repository. - items: *238 + items: *241 required: - action - repository @@ -109201,18 +110347,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *679 - installation: *680 - organization: *681 - pusher_type: *688 - ref: *689 + enterprise: *689 + installation: *690 + organization: *691 + pusher_type: *698 + ref: *699 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *682 + repository: *692 sender: *4 required: - ref @@ -109296,11 +110442,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109384,11 +110530,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109472,11 +110618,11 @@ x-webhooks: type: string enum: - created - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109558,11 +110704,11 @@ x-webhooks: type: string enum: - dismissed - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109644,11 +110790,11 @@ x-webhooks: type: string enum: - fixed - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109731,11 +110877,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109817,11 +110963,11 @@ x-webhooks: type: string enum: - reopened - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109898,9 +111044,9 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - key: &690 + enterprise: *689 + installation: *690 + key: &700 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -109936,8 +111082,8 @@ x-webhooks: - verified - created_at - read_only - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -110014,11 +111160,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - key: *690 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + key: *700 + organization: *691 + repository: *692 sender: *4 required: - action @@ -110579,12 +111725,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - workflow: &694 + workflow: &704 title: Workflow type: object nullable: true @@ -111310,13 +112456,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *462 + deployment: *472 pull_requests: type: array - items: *547 - repository: *682 - organization: *681 - installation: *680 + items: *557 + repository: *692 + organization: *691 + installation: *690 sender: *4 responses: '200': @@ -111387,7 +112533,7 @@ x-webhooks: type: string enum: - approved - approver: &691 + approver: &701 type: object properties: avatar_url: @@ -111430,11 +112576,11 @@ x-webhooks: type: string comment: type: string - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - reviewers: &692 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + reviewers: &702 type: array items: type: object @@ -111513,7 +112659,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &693 + workflow_job_run: &703 type: object properties: conclusion: @@ -112244,18 +113390,18 @@ x-webhooks: type: string enum: - rejected - approver: *691 + approver: *701 comment: type: string - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - reviewers: *692 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + reviewers: *702 sender: *4 since: type: string - workflow_job_run: *693 + workflow_job_run: *703 workflow_job_runs: type: array items: @@ -112959,13 +114105,13 @@ x-webhooks: type: string enum: - requested - enterprise: *679 + enterprise: *689 environment: type: string - installation: *680 - organization: *681 - repository: *682 - requestor: &699 + installation: *690 + organization: *691 + repository: *692 + requestor: &709 title: User type: object nullable: true @@ -114864,12 +116010,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - workflow: *694 + workflow: *704 workflow_run: title: Deployment Workflow Run type: object @@ -115549,7 +116695,7 @@ x-webhooks: type: string enum: - answered - answer: &697 + answer: &707 type: object properties: author_association: @@ -115706,7 +116852,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &695 + discussion: &705 title: Discussion description: A Discussion in a repository. type: object @@ -115992,7 +117138,7 @@ x-webhooks: - id labels: type: array - items: *509 + items: *520 required: - repository_url - category @@ -116014,10 +117160,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116144,11 +117290,11 @@ x-webhooks: - from required: - category - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116231,11 +117377,11 @@ x-webhooks: type: string enum: - closed - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116317,7 +117463,7 @@ x-webhooks: type: string enum: - created - comment: &696 + comment: &706 type: object properties: author_association: @@ -116474,11 +117620,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116561,12 +117707,12 @@ x-webhooks: type: string enum: - deleted - comment: *696 - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + comment: *706 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116661,12 +117807,12 @@ x-webhooks: - from required: - body - comment: *696 - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + comment: *706 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116750,11 +117896,11 @@ x-webhooks: type: string enum: - created - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116836,11 +117982,11 @@ x-webhooks: type: string enum: - deleted - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116940,11 +118086,11 @@ x-webhooks: type: string required: - from - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117026,10 +118172,10 @@ x-webhooks: type: string enum: - labeled - discussion: *695 - enterprise: *679 - installation: *680 - label: &698 + discussion: *705 + enterprise: *689 + installation: *690 + label: &708 title: Label type: object properties: @@ -117061,8 +118207,8 @@ x-webhooks: - color - default - description - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117145,11 +118291,11 @@ x-webhooks: type: string enum: - locked - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117231,11 +118377,11 @@ x-webhooks: type: string enum: - pinned - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117317,11 +118463,11 @@ x-webhooks: type: string enum: - reopened - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117406,16 +118552,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *695 - new_repository: *682 + new_discussion: *705 + new_repository: *692 required: - new_discussion - new_repository - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117498,10 +118644,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *695 - old_answer: *697 - organization: *681 - repository: *682 + discussion: *705 + old_answer: *707 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117583,12 +118729,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *695 - enterprise: *679 - installation: *680 - label: *698 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117671,11 +118817,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117757,11 +118903,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117834,7 +118980,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *679 + enterprise: *689 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -118494,9 +119640,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - forkee @@ -118642,9 +119788,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pages: description: The pages that were updated. type: array @@ -118681,7 +119827,7 @@ x-webhooks: - action - sha - html_url - repository: *682 + repository: *692 sender: *4 required: - pages @@ -118757,10 +119903,10 @@ x-webhooks: type: string enum: - created - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories: &700 + organization: *691 + repositories: &710 description: An array of repository objects that the installation can access. type: array @@ -118786,8 +119932,8 @@ x-webhooks: - name - full_name - private - repository: *682 - requester: *699 + repository: *692 + requester: *709 sender: *4 required: - action @@ -118862,11 +120008,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories: *700 - repository: *682 + organization: *691 + repositories: *710 + repository: *692 requester: nullable: true sender: *4 @@ -118942,11 +120088,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories: *700 - repository: *682 + organization: *691 + repositories: *710 + repository: *692 requester: nullable: true sender: *4 @@ -119022,10 +120168,10 @@ x-webhooks: type: string enum: - added - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories_added: &701 + organization: *691 + repositories_added: &711 description: An array of repository objects, which were added to the installation. type: array @@ -119071,15 +120217,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *682 - repository_selection: &702 + repository: *692 + repository_selection: &712 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *699 + requester: *709 sender: *4 required: - action @@ -119158,10 +120304,10 @@ x-webhooks: type: string enum: - removed - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories_added: *701 + organization: *691 + repositories_added: *711 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -119188,9 +120334,9 @@ x-webhooks: - name - full_name - private - repository: *682 - repository_selection: *702 - requester: *699 + repository: *692 + repository_selection: *712 + requester: *709 sender: *4 required: - action @@ -119269,11 +120415,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories: *700 - repository: *682 + organization: *691 + repositories: *710 + repository: *692 requester: nullable: true sender: *4 @@ -119451,10 +120597,10 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 target_type: type: string @@ -119533,11 +120679,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories: *700 - repository: *682 + organization: *691 + repositories: *710 + repository: *692 requester: nullable: true sender: *4 @@ -119789,8 +120935,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -120584,7 +121730,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -120600,7 +121747,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -120933,8 +122080,8 @@ x-webhooks: - state - locked - assignee - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -121014,7 +122161,7 @@ x-webhooks: type: string enum: - deleted - comment: &703 + comment: &713 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -121179,8 +122326,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -121970,7 +123117,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -121986,7 +123134,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -122321,8 +123469,8 @@ x-webhooks: - state - locked - assignee - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -122402,7 +123550,7 @@ x-webhooks: type: string enum: - edited - changes: &731 + changes: &743 description: The changes to the comment. type: object properties: @@ -122414,9 +123562,9 @@ x-webhooks: type: string required: - from - comment: *703 - enterprise: *679 - installation: *680 + comment: *713 + enterprise: *689 + installation: *690 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -123209,7 +124357,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -123225,7 +124374,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -123558,8 +124707,8 @@ x-webhooks: - state - locked - assignee - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -123649,9 +124798,9 @@ x-webhooks: type: number blocking_issue: *77 blocking_issue_repo: *60 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -123745,9 +124894,9 @@ x-webhooks: type: number blocking_issue: *77 blocking_issue_repo: *60 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -123840,9 +124989,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -123936,9 +125085,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -124023,10 +125172,10 @@ x-webhooks: type: string enum: - assigned - assignee: *699 - enterprise: *679 - installation: *680 - issue: &706 + assignee: *709 + enterprise: *689 + installation: *690 + issue: &716 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -124815,7 +125964,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -124831,7 +125981,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -124932,8 +126082,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -125013,8 +126163,8 @@ x-webhooks: type: string enum: - closed - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -125808,7 +126958,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -125824,7 +126975,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -126060,8 +127211,8 @@ x-webhooks: required: - state - closed_at - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -126140,8 +127291,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126926,7 +128077,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -126942,7 +128094,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -127042,8 +128194,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -127122,8 +128274,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127930,7 +129082,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127946,7 +129099,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -128025,7 +129178,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &704 + milestone: &714 title: Milestone description: A collection of related issues and pull requests. type: object @@ -128163,8 +129316,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -128263,8 +129416,8 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129053,7 +130206,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129066,7 +130220,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *196 + type: *199 title: description: Title of the issue type: string @@ -129170,9 +130324,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *698 - organization: *681 - repository: *682 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -129252,8 +130406,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -130041,7 +131195,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130054,7 +131209,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *196 + type: *199 title: description: Title of the issue type: string @@ -130158,9 +131313,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *698 - organization: *681 - repository: *682 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -130240,8 +131395,8 @@ x-webhooks: type: string enum: - locked - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131053,7 +132208,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131066,7 +132222,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *196 + type: *199 title: description: Title of the issue type: string @@ -131147,8 +132303,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -131227,8 +132383,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132034,7 +133190,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132050,7 +133207,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -132128,9 +133285,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *704 - organization: *681 - repository: *682 + milestone: *714 + organization: *691 + repository: *692 sender: *4 required: - action @@ -132998,7 +134155,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133091,7 +134249,7 @@ x-webhooks: required: - login - id - type: *196 + type: *199 required: - id - number @@ -133560,8 +134718,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134350,7 +135508,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134366,7 +135525,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -134466,8 +135625,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -134547,9 +135706,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *679 - installation: *680 - issue: &705 + enterprise: *689 + installation: *690 + issue: &715 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -135332,7 +136491,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135348,7 +136508,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -135448,8 +136608,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -135528,8 +136688,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136339,7 +137499,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136433,9 +137594,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *196 - organization: *681 - repository: *682 + type: *199 + organization: *691 + repository: *692 sender: *4 required: - action @@ -137301,7 +138462,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137317,7 +138479,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -137885,11 +139047,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *679 - installation: *680 - issue: *705 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *715 + organization: *691 + repository: *692 sender: *4 required: - action @@ -137969,12 +139131,12 @@ x-webhooks: type: string enum: - typed - enterprise: *679 - installation: *680 - issue: *706 - type: *196 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *716 + type: *199 + organization: *691 + repository: *692 sender: *4 required: - action @@ -138055,7 +139217,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &734 + assignee: &746 title: User type: object nullable: true @@ -138125,11 +139287,11 @@ x-webhooks: required: - login - id - enterprise: *679 - installation: *680 - issue: *706 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *716 + organization: *691 + repository: *692 sender: *4 required: - action @@ -138208,12 +139370,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *679 - installation: *680 - issue: *706 - label: *698 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *716 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -138293,8 +139455,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139104,7 +140266,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139120,7 +140283,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -139198,8 +140361,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139279,11 +140442,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *679 - installation: *680 - issue: *705 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *715 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139362,12 +140525,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *679 - installation: *680 - issue: *706 - type: *196 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *716 + type: *199 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139447,11 +140610,11 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - label: *698 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139529,11 +140692,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - label: *698 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139643,11 +140806,11 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - label: *698 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139729,9 +140892,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *679 - installation: *680 - marketplace_purchase: &707 + enterprise: *689 + installation: *690 + marketplace_purchase: &717 title: Marketplace Purchase type: object required: @@ -139814,8 +140977,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *681 - previous_marketplace_purchase: &708 + organization: *691 + previous_marketplace_purchase: &718 title: Marketplace Purchase type: object properties: @@ -139895,7 +141058,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *682 + repository: *692 sender: *4 required: - action @@ -139975,10 +141138,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *679 - installation: *680 - marketplace_purchase: *707 - organization: *681 + enterprise: *689 + installation: *690 + marketplace_purchase: *717 + organization: *691 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -140061,7 +141224,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *682 + repository: *692 sender: *4 required: - action @@ -140143,10 +141306,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *679 - installation: *680 - marketplace_purchase: *707 - organization: *681 + enterprise: *689 + installation: *690 + marketplace_purchase: *717 + organization: *691 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -140228,7 +141391,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *682 + repository: *692 sender: *4 required: - action @@ -140309,8 +141472,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 marketplace_purchase: title: Marketplace Purchase type: object @@ -140392,9 +141555,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *681 - previous_marketplace_purchase: *708 - repository: *682 + organization: *691 + previous_marketplace_purchase: *718 + repository: *692 sender: *4 required: - action @@ -140474,12 +141637,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *679 - installation: *680 - marketplace_purchase: *707 - organization: *681 - previous_marketplace_purchase: *708 - repository: *682 + enterprise: *689 + installation: *690 + marketplace_purchase: *717 + organization: *691 + previous_marketplace_purchase: *718 + repository: *692 sender: *4 required: - action @@ -140581,11 +141744,11 @@ x-webhooks: type: string required: - to - enterprise: *679 - installation: *680 - member: *699 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + member: *709 + organization: *691 + repository: *692 sender: *4 required: - action @@ -140685,11 +141848,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *679 - installation: *680 - member: *699 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + member: *709 + organization: *691 + repository: *692 sender: *4 required: - action @@ -140768,11 +141931,11 @@ x-webhooks: type: string enum: - removed - enterprise: *679 - installation: *680 - member: *699 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + member: *709 + organization: *691 + repository: *692 sender: *4 required: - action @@ -140850,11 +142013,11 @@ x-webhooks: type: string enum: - added - enterprise: *679 - installation: *680 - member: *699 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + member: *709 + organization: *691 + repository: *692 scope: description: The scope of the membership. Currently, can only be `team`. @@ -140930,7 +142093,7 @@ x-webhooks: required: - login - id - team: &709 + team: &719 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -141120,11 +142283,11 @@ x-webhooks: type: string enum: - removed - enterprise: *679 - installation: *680 - member: *699 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + member: *709 + organization: *691 + repository: *692 scope: description: The scope of the membership. Currently, can only be `team`. @@ -141201,7 +142364,7 @@ x-webhooks: required: - login - id - team: *709 + team: *719 required: - action - scope @@ -141283,8 +142446,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *680 - merge_group: &711 + installation: *690 + merge_group: &721 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -141303,15 +142466,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *710 + head_commit: *720 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -141397,10 +142560,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *680 - merge_group: *711 - organization: *681 - repository: *682 + installation: *690 + merge_group: *721 + organization: *691 + repository: *692 sender: *4 required: - action @@ -141473,7 +142636,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 + enterprise: *689 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -141582,16 +142745,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *680 - organization: *681 + installation: *690 + organization: *691 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *712 - required: *713 + properties: *722 + required: *723 nullable: true sender: *4 required: @@ -141672,11 +142835,11 @@ x-webhooks: type: string enum: - closed - enterprise: *679 - installation: *680 - milestone: *704 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + milestone: *714 + organization: *691 + repository: *692 sender: *4 required: - action @@ -141755,9 +142918,9 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - milestone: &714 + enterprise: *689 + installation: *690 + milestone: &724 title: Milestone description: A collection of related issues and pull requests. type: object @@ -141894,8 +143057,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -141974,11 +143137,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - milestone: *704 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + milestone: *714 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142088,11 +143251,11 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - milestone: *704 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + milestone: *714 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142172,11 +143335,11 @@ x-webhooks: type: string enum: - opened - enterprise: *679 - installation: *680 - milestone: *714 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + milestone: *724 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142255,11 +143418,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *699 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + blocked_user: *709 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142338,11 +143501,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *699 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + blocked_user: *709 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142421,9 +143584,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - membership: &715 + enterprise: *689 + installation: *690 + membership: &725 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -142530,8 +143693,8 @@ x-webhooks: - role - organization_url - user - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142609,11 +143772,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *679 - installation: *680 - membership: *715 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + membership: *725 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142692,8 +143855,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -142809,10 +143972,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 - user: *699 + user: *709 required: - action - invitation @@ -142890,11 +144053,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *679 - installation: *680 - membership: *715 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + membership: *725 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142981,11 +144144,11 @@ x-webhooks: properties: from: type: string - enterprise: *679 - installation: *680 - membership: *715 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + membership: *725 + organization: *691 + repository: *692 sender: *4 required: - action @@ -143061,9 +144224,9 @@ x-webhooks: type: string enum: - published - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 package: description: Information about the package. type: object @@ -143562,7 +144725,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &716 + items: &726 title: Ruby Gems metadata type: object properties: @@ -143657,7 +144820,7 @@ x-webhooks: - owner - package_version - registry - repository: *682 + repository: *692 sender: *4 required: - action @@ -143733,9 +144896,9 @@ x-webhooks: type: string enum: - updated - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 package: description: Information about the package. type: object @@ -144088,7 +145251,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *716 + items: *726 source_url: type: string format: uri @@ -144158,7 +145321,7 @@ x-webhooks: - owner - package_version - registry - repository: *682 + repository: *692 sender: *4 required: - action @@ -144335,12 +145498,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *679 + enterprise: *689 id: type: integer - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - id @@ -144417,7 +145580,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &717 + personal_access_token_request: &727 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -144563,10 +145726,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *679 - organization: *681 + enterprise: *689 + organization: *691 sender: *4 - installation: *680 + installation: *690 required: - action - personal_access_token_request @@ -144643,11 +145806,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *717 - enterprise: *679 - organization: *681 + personal_access_token_request: *727 + enterprise: *689 + organization: *691 sender: *4 - installation: *680 + installation: *690 required: - action - personal_access_token_request @@ -144723,11 +145886,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *717 - enterprise: *679 - organization: *681 + personal_access_token_request: *727 + enterprise: *689 + organization: *691 sender: *4 - installation: *680 + installation: *690 required: - action - personal_access_token_request @@ -144802,11 +145965,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *717 - organization: *681 - enterprise: *679 + personal_access_token_request: *727 + organization: *691 + enterprise: *689 sender: *4 - installation: *680 + installation: *690 required: - action - personal_access_token_request @@ -144911,7 +146074,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *718 + last_response: *728 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -144943,8 +146106,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 zen: description: Random string of GitHub zen. @@ -145189,10 +146352,10 @@ x-webhooks: - from required: - note - enterprise: *679 - installation: *680 - organization: *681 - project_card: &719 + enterprise: *689 + installation: *690 + organization: *691 + project_card: &729 title: Project Card type: object properties: @@ -145311,7 +146474,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *682 + repository: *692 sender: *4 required: - action @@ -145392,11 +146555,11 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - project_card: *719 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project_card: *729 + repository: *692 sender: *4 required: - action @@ -145476,9 +146639,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 project_card: title: Project Card type: object @@ -145606,8 +146769,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *712 - required: *713 + properties: *722 + required: *723 nullable: true sender: *4 required: @@ -145701,11 +146864,11 @@ x-webhooks: - from required: - note - enterprise: *679 - installation: *680 - organization: *681 - project_card: *719 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project_card: *729 + repository: *692 sender: *4 required: - action @@ -145799,9 +146962,9 @@ x-webhooks: - from required: - column_id - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 project_card: allOf: - title: Project Card @@ -145991,7 +147154,7 @@ x-webhooks: type: string required: - after_id - repository: *682 + repository: *692 sender: *4 required: - action @@ -146071,10 +147234,10 @@ x-webhooks: type: string enum: - closed - enterprise: *679 - installation: *680 - organization: *681 - project: &721 + enterprise: *689 + installation: *690 + organization: *691 + project: &731 title: Project type: object properties: @@ -146198,7 +147361,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *682 + repository: *692 sender: *4 required: - action @@ -146278,10 +147441,10 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - project_column: &720 + enterprise: *689 + installation: *690 + organization: *691 + project_column: &730 title: Project Column type: object properties: @@ -146320,7 +147483,7 @@ x-webhooks: - name - created_at - updated_at - repository: *682 + repository: *692 sender: *4 required: - action @@ -146399,18 +147562,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - project_column: *720 + enterprise: *689 + installation: *690 + organization: *691 + project_column: *730 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *712 - required: *713 + properties: *722 + required: *723 nullable: true sender: *4 required: @@ -146500,11 +147663,11 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - organization: *681 - project_column: *720 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project_column: *730 + repository: *692 sender: *4 required: - action @@ -146584,11 +147747,11 @@ x-webhooks: type: string enum: - moved - enterprise: *679 - installation: *680 - organization: *681 - project_column: *720 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project_column: *730 + repository: *692 sender: *4 required: - action @@ -146668,11 +147831,11 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - project: *721 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project: *731 + repository: *692 sender: *4 required: - action @@ -146752,18 +147915,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - project: *721 + enterprise: *689 + installation: *690 + organization: *691 + project: *731 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *712 - required: *713 + properties: *722 + required: *723 nullable: true sender: *4 required: @@ -146865,11 +148028,11 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - organization: *681 - project: *721 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project: *731 + repository: *692 sender: *4 required: - action @@ -146948,11 +148111,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *679 - installation: *680 - organization: *681 - project: *721 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project: *731 + repository: *692 sender: *4 required: - action @@ -147033,9 +148196,9 @@ x-webhooks: type: string enum: - closed - installation: *680 - organization: *681 - projects_v2: &722 + installation: *690 + organization: *691 + projects_v2: &732 title: Projects v2 Project description: A projects v2 project type: object @@ -147083,6 +148246,62 @@ x-webhooks: properties: *20 required: *21 nullable: true + state: + type: string + enum: + - open + - closed + latest_status_update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: &737 + id: + type: number + node_id: + type: string + project_node_id: + type: string + creator: *4 + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + start_date: + type: string + format: date + example: '2022-04-28' + target_date: + type: string + format: date + example: '2022-04-28' + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: &738 + - id + - node_id + - created_at + - updated_at + nullable: true + is_template: + type: boolean + description: Whether this project is a template required: - id - node_id @@ -147178,9 +148397,9 @@ x-webhooks: type: string enum: - created - installation: *680 - organization: *681 - projects_v2: *722 + installation: *690 + organization: *691 + projects_v2: *732 sender: *4 required: - action @@ -147261,9 +148480,9 @@ x-webhooks: type: string enum: - deleted - installation: *680 - organization: *681 - projects_v2: *722 + installation: *690 + organization: *691 + projects_v2: *732 sender: *4 required: - action @@ -147380,9 +148599,9 @@ x-webhooks: type: string to: type: string - installation: *680 - organization: *681 - projects_v2: *722 + installation: *690 + organization: *691 + projects_v2: *732 sender: *4 required: - action @@ -147465,7 +148684,7 @@ x-webhooks: type: string enum: - archived - changes: &726 + changes: &736 type: object properties: archived_at: @@ -147479,9 +148698,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *680 - organization: *681 - projects_v2_item: &723 + installation: *690 + organization: *691 + projects_v2_item: &733 title: Projects v2 Item description: An item belonging to a project type: object @@ -147615,9 +148834,9 @@ x-webhooks: nullable: true to: type: string - installation: *680 - organization: *681 - projects_v2_item: *723 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -147699,9 +148918,9 @@ x-webhooks: type: string enum: - created - installation: *680 - organization: *681 - projects_v2_item: *723 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -147782,9 +149001,9 @@ x-webhooks: type: string enum: - deleted - installation: *680 - organization: *681 - projects_v2_item: *723 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -147890,7 +149109,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &724 + - &734 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -147908,7 +149127,7 @@ x-webhooks: required: - id - name - - &725 + - &735 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -147931,8 +149150,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *724 - - *725 + - *734 + - *735 required: - field_value - type: object @@ -147948,9 +149167,9 @@ x-webhooks: nullable: true required: - body - installation: *680 - organization: *681 - projects_v2_item: *723 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -148045,9 +149264,9 @@ x-webhooks: to: type: string nullable: true - installation: *680 - organization: *681 - projects_v2_item: *723 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -148130,10 +149349,10 @@ x-webhooks: type: string enum: - restored - changes: *726 - installation: *680 - organization: *681 - projects_v2_item: *723 + changes: *736 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -148215,9 +149434,9 @@ x-webhooks: type: string enum: - reopened - installation: *680 - organization: *681 - projects_v2: *722 + installation: *690 + organization: *691 + projects_v2: *732 sender: *4 required: - action @@ -148298,55 +149517,14 @@ x-webhooks: type: string enum: - created - installation: *680 - organization: *681 - projects_v2_status_update: &727 + installation: *690 + organization: *691 + projects_v2_status_update: &739 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: - id: - type: number - node_id: - type: string - project_node_id: - type: string - creator: *4 - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - status: - type: string - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - nullable: true - start_date: - type: string - format: date - example: '2022-04-28' - target_date: - type: string - format: date - example: '2022-04-28' - body: - description: Body of the status update - example: The project is off to a great start! - type: string - nullable: true - required: - - id - - node_id - - created_at - - updated_at + properties: *737 + required: *738 sender: *4 required: - action @@ -148427,9 +149605,9 @@ x-webhooks: type: string enum: - deleted - installation: *680 - organization: *681 - projects_v2_status_update: *727 + installation: *690 + organization: *691 + projects_v2_status_update: *739 sender: *4 required: - action @@ -148565,9 +149743,9 @@ x-webhooks: type: string format: date nullable: true - installation: *680 - organization: *681 - projects_v2_status_update: *727 + installation: *690 + organization: *691 + projects_v2_status_update: *739 sender: *4 required: - action @@ -148638,10 +149816,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - repository @@ -148718,13 +149896,13 @@ x-webhooks: type: string enum: - assigned - assignee: *699 - enterprise: *679 - installation: *680 - number: &728 + assignee: *709 + enterprise: *689 + installation: *690 + number: &740 description: The pull request number. type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -151007,7 +152185,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -151089,11 +152267,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -153371,7 +154549,7 @@ x-webhooks: - draft reason: type: string - repository: *682 + repository: *692 sender: *4 required: - action @@ -153453,11 +154631,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -155735,7 +156913,7 @@ x-webhooks: - draft reason: type: string - repository: *682 + repository: *692 sender: *4 required: - action @@ -155817,13 +156995,13 @@ x-webhooks: type: string enum: - closed - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: &729 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: &741 allOf: - - *547 + - *557 - type: object properties: allow_auto_merge: @@ -155885,7 +157063,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *682 + repository: *692 sender: *4 required: - action @@ -155966,12 +157144,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: *729 - repository: *682 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: *741 + repository: *692 sender: *4 required: - action @@ -156051,11 +157229,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *679 - milestone: *530 - number: *728 - organization: *681 - pull_request: &730 + enterprise: *689 + milestone: *540 + number: *740 + organization: *691 + pull_request: &742 title: Pull Request type: object properties: @@ -158318,7 +159496,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -158397,11 +159575,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -160683,7 +161861,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *682 + repository: *692 sender: *4 required: - action @@ -160807,12 +161985,12 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: *729 - repository: *682 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: *741 + repository: *692 sender: *4 required: - action @@ -160892,11 +162070,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -163163,7 +164341,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -163243,11 +164421,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *679 - installation: *680 - label: *698 - number: *728 - organization: *681 + enterprise: *689 + installation: *690 + label: *708 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -165529,7 +166707,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -165610,10 +166788,10 @@ x-webhooks: type: string enum: - locked - enterprise: *679 - installation: *680 - number: *728 - organization: *681 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -167893,7 +169071,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -167973,12 +169151,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *679 - milestone: *530 - number: *728 - organization: *681 - pull_request: *730 - repository: *682 + enterprise: *689 + milestone: *540 + number: *740 + organization: *691 + pull_request: *742 + repository: *692 sender: *4 required: - action @@ -168057,12 +169235,12 @@ x-webhooks: type: string enum: - opened - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: *729 - repository: *682 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: *741 + repository: *692 sender: *4 required: - action @@ -168143,12 +169321,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: *729 - repository: *682 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: *741 + repository: *692 sender: *4 required: - action @@ -168228,12 +169406,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: *729 - repository: *682 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: *741 + repository: *692 sender: *4 required: - action @@ -168599,9 +169777,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: type: object properties: @@ -170771,7 +171949,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *682 + repository: *692 sender: *4 required: - action @@ -170851,7 +172029,7 @@ x-webhooks: type: string enum: - deleted - comment: &732 + comment: &744 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -171136,9 +172314,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: type: object properties: @@ -173296,7 +174474,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *682 + repository: *692 sender: *4 required: - action @@ -173376,11 +174554,11 @@ x-webhooks: type: string enum: - edited - changes: *731 - comment: *732 - enterprise: *679 - installation: *680 - organization: *681 + changes: *743 + comment: *744 + enterprise: *689 + installation: *690 + organization: *691 pull_request: type: object properties: @@ -175541,7 +176719,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *682 + repository: *692 sender: *4 required: - action @@ -175622,9 +176800,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: title: Simple Pull Request type: object @@ -177797,7 +178975,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *682 + repository: *692 review: description: The review that was affected. type: object @@ -178040,9 +179218,9 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: title: Simple Pull Request type: object @@ -180096,8 +181274,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *682 - review: &733 + repository: *692 + review: &745 description: The review that was affected. type: object properties: @@ -180326,12 +181504,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: description: The pull request number. type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -182614,7 +183792,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 requested_reviewer: title: User type: object @@ -182698,12 +183876,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: description: The pull request number. type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -184993,7 +186171,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 requested_team: title: Team description: Groups of organization members that gives permissions @@ -185185,12 +186363,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: description: The pull request number. type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -187475,7 +188653,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 requested_reviewer: title: User type: object @@ -187560,12 +188738,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: description: The pull request number. type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -189841,7 +191019,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190022,9 +191200,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: title: Simple Pull Request type: object @@ -192199,8 +193377,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *682 - review: *733 + repository: *692 + review: *745 sender: *4 required: - action @@ -192280,9 +193458,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: title: Simple Pull Request type: object @@ -194352,7 +195530,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *682 + repository: *692 sender: *4 thread: type: object @@ -194735,9 +195913,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: title: Simple Pull Request type: object @@ -196793,7 +197971,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *682 + repository: *692 sender: *4 thread: type: object @@ -197179,10 +198357,10 @@ x-webhooks: type: string before: type: string - enterprise: *679 - installation: *680 - number: *728 - organization: *681 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -199453,7 +200631,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -199535,11 +200713,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *734 - enterprise: *679 - installation: *680 - number: *728 - organization: *681 + assignee: *746 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -201822,7 +203000,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -201901,11 +203079,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *679 - installation: *680 - label: *698 - number: *728 - organization: *681 + enterprise: *689 + installation: *690 + label: *708 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -204178,7 +205356,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -204259,10 +205437,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *679 - installation: *680 - number: *728 - organization: *681 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -206527,7 +207705,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -206727,7 +207905,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *679 + enterprise: *689 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -206819,8 +207997,8 @@ x-webhooks: - url - author - committer - installation: *680 - organization: *681 + installation: *690 + organization: *691 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -207395,9 +208573,9 @@ x-webhooks: type: string enum: - published - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 registry_package: type: object properties: @@ -207843,7 +209021,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *716 + items: *726 summary: type: string tag_name: @@ -207897,7 +209075,7 @@ x-webhooks: - owner - package_version - registry - repository: *682 + repository: *692 sender: *4 required: - action @@ -207975,9 +209153,9 @@ x-webhooks: type: string enum: - updated - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 registry_package: type: object properties: @@ -208285,7 +209463,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *716 + items: *726 summary: type: string tag_name: @@ -208334,7 +209512,7 @@ x-webhooks: - owner - package_version - registry - repository: *682 + repository: *692 sender: *4 required: - action @@ -208411,10 +209589,10 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - release: &735 + enterprise: *689 + installation: *690 + organization: *691 + release: &747 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -208727,7 +209905,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *682 + repository: *692 sender: *4 required: - action @@ -208804,11 +209982,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - release: *735 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + release: *747 + repository: *692 sender: *4 required: - action @@ -208925,11 +210103,11 @@ x-webhooks: type: boolean required: - to - enterprise: *679 - installation: *680 - organization: *681 - release: *735 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + release: *747 + repository: *692 sender: *4 required: - action @@ -209007,9 +210185,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -209326,7 +210504,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *682 + repository: *692 sender: *4 required: - action @@ -209402,10 +210580,10 @@ x-webhooks: type: string enum: - published - enterprise: *679 - installation: *680 - organization: *681 - release: &736 + enterprise: *689 + installation: *690 + organization: *691 + release: &748 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -209719,7 +210897,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *682 + repository: *692 sender: *4 required: - action @@ -209795,11 +210973,11 @@ x-webhooks: type: string enum: - released - enterprise: *679 - installation: *680 - organization: *681 - release: *735 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + release: *747 + repository: *692 sender: *4 required: - action @@ -209875,11 +211053,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *679 - installation: *680 - organization: *681 - release: *736 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + release: *748 + repository: *692 sender: *4 required: - action @@ -209955,11 +211133,11 @@ x-webhooks: type: string enum: - published - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - repository_advisory: *602 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + repository_advisory: *612 sender: *4 required: - action @@ -210035,11 +211213,11 @@ x-webhooks: type: string enum: - reported - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - repository_advisory: *602 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + repository_advisory: *612 sender: *4 required: - action @@ -210115,10 +211293,10 @@ x-webhooks: type: string enum: - archived - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210195,10 +211373,10 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210276,10 +211454,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210363,10 +211541,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210478,10 +211656,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210553,10 +211731,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 status: type: string @@ -210637,10 +211815,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210717,10 +211895,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210814,10 +211992,10 @@ x-webhooks: - name required: - repository - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210897,11 +212075,11 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - repository_ruleset: *267 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + repository_ruleset: *270 sender: *4 required: - action @@ -210979,11 +212157,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - repository_ruleset: *267 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + repository_ruleset: *270 sender: *4 required: - action @@ -211061,11 +212239,11 @@ x-webhooks: type: string enum: - edited - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - repository_ruleset: *267 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + repository_ruleset: *270 changes: type: object properties: @@ -211084,16 +212262,16 @@ x-webhooks: properties: added: type: array - items: *242 + items: *245 deleted: type: array - items: *242 + items: *245 updated: type: array items: type: object properties: - condition: *242 + condition: *245 changes: type: object properties: @@ -211126,16 +212304,16 @@ x-webhooks: properties: added: type: array - items: *567 + items: *577 deleted: type: array - items: *567 + items: *577 updated: type: array items: type: object properties: - rule: *567 + rule: *577 changes: type: object properties: @@ -211369,10 +212547,10 @@ x-webhooks: - from required: - owner - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -211450,10 +212628,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -211531,7 +212709,7 @@ x-webhooks: type: string enum: - create - alert: &737 + alert: &749 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -211652,10 +212830,10 @@ x-webhooks: type: string enum: - open - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -211861,10 +213039,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -211942,11 +213120,11 @@ x-webhooks: type: string enum: - reopen - alert: *737 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + alert: *749 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212145,10 +213323,10 @@ x-webhooks: enum: - fixed - open - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212226,7 +213404,7 @@ x-webhooks: type: string enum: - created - alert: &738 + alert: &750 type: object properties: number: *54 @@ -212337,10 +213515,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212421,11 +213599,11 @@ x-webhooks: type: string enum: - created - alert: *738 - installation: *680 - location: *739 - organization: *681 - repository: *682 + alert: *750 + installation: *690 + location: *751 + organization: *691 + repository: *692 sender: *4 required: - location @@ -212663,11 +213841,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *738 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + alert: *750 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212745,11 +213923,11 @@ x-webhooks: type: string enum: - reopened - alert: *738 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + alert: *750 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212827,11 +214005,11 @@ x-webhooks: type: string enum: - resolved - alert: *738 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + alert: *750 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212909,11 +214087,11 @@ x-webhooks: type: string enum: - validated - alert: *738 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + alert: *750 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -213039,10 +214217,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *682 - enterprise: *679 - installation: *680 - organization: *681 + repository: *692 + enterprise: *689 + installation: *690 + organization: *691 sender: *4 required: - action @@ -213120,11 +214298,11 @@ x-webhooks: type: string enum: - published - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - security_advisory: &740 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + security_advisory: &752 description: The details of the security advisory, including summary, description, and severity. type: object @@ -213307,11 +214485,11 @@ x-webhooks: type: string enum: - updated - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - security_advisory: *740 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + security_advisory: *752 sender: *4 required: - action @@ -213384,10 +214562,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -213571,11 +214749,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *241 - enterprise: *679 - installation: *680 - organization: *681 - repository: *315 + security_and_analysis: *244 + enterprise: *689 + installation: *690 + organization: *691 + repository: *320 sender: *4 required: - changes @@ -213653,12 +214831,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: &741 + sponsorship: &753 type: object properties: created_at: @@ -213959,12 +215137,12 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: *741 + sponsorship: *753 required: - action - sponsorship @@ -214052,12 +215230,12 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: *741 + sponsorship: *753 required: - action - changes @@ -214134,17 +215312,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &742 + effective_date: &754 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: *741 + sponsorship: *753 required: - action - sponsorship @@ -214218,7 +215396,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &743 + changes: &755 type: object properties: tier: @@ -214262,13 +215440,13 @@ x-webhooks: - from required: - tier - effective_date: *742 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + effective_date: *754 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: *741 + sponsorship: *753 required: - action - changes @@ -214345,13 +215523,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *743 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + changes: *755 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: *741 + sponsorship: *753 required: - action - changes @@ -214425,10 +215603,10 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -214511,10 +215689,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -214934,15 +216112,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *679 + enterprise: *689 id: description: The unique identifier of the status. type: integer - installation: *680 + installation: *690 name: type: string - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 sha: description: The Commit SHA. @@ -215057,9 +216235,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -215149,9 +216327,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -215241,9 +216419,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -215333,9 +216511,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -215412,12 +216590,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - team: &744 + team: &756 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -215607,9 +216785,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 repository: title: Repository description: A git repository @@ -216067,7 +217245,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *744 + team: *756 required: - action - team @@ -216143,9 +217321,9 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 repository: title: Repository description: A git repository @@ -216603,7 +217781,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *744 + team: *756 required: - action - team @@ -216680,9 +217858,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 repository: title: Repository description: A git repository @@ -217140,7 +218318,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *744 + team: *756 required: - action - team @@ -217284,9 +218462,9 @@ x-webhooks: - from required: - permissions - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 repository: title: Repository description: A git repository @@ -217744,7 +218922,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *744 + team: *756 required: - action - changes @@ -217822,9 +219000,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 repository: title: Repository description: A git repository @@ -218282,7 +219460,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *744 + team: *756 required: - action - team @@ -218358,10 +219536,10 @@ x-webhooks: type: string enum: - started - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -218434,16 +219612,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *679 + enterprise: *689 inputs: type: object nullable: true additionalProperties: true - installation: *680 - organization: *681 + installation: *690 + organization: *691 ref: type: string - repository: *682 + repository: *692 sender: *4 workflow: type: string @@ -218525,10 +219703,10 @@ x-webhooks: type: string enum: - completed - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 workflow_job: allOf: @@ -218765,7 +219943,7 @@ x-webhooks: type: string required: - conclusion - deployment: *462 + deployment: *472 required: - action - repository @@ -218844,10 +220022,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 workflow_job: allOf: @@ -219107,7 +220285,7 @@ x-webhooks: required: - status - steps - deployment: *462 + deployment: *472 required: - action - repository @@ -219186,10 +220364,10 @@ x-webhooks: type: string enum: - queued - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 workflow_job: type: object @@ -219324,7 +220502,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *462 + deployment: *472 required: - action - repository @@ -219403,10 +220581,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 workflow_job: type: object @@ -219542,7 +220720,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *462 + deployment: *472 required: - action - repository @@ -219622,12 +220800,12 @@ x-webhooks: type: string enum: - completed - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - workflow: *694 + workflow: *704 workflow_run: title: Workflow Run type: object @@ -220626,12 +221804,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - workflow: *694 + workflow: *704 workflow_run: title: Workflow Run type: object @@ -221615,12 +222793,12 @@ x-webhooks: type: string enum: - requested - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - workflow: *694 + workflow: *704 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 60df0fe511..d82485b918 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -187,6 +187,10 @@ { "name": "campaigns", "description": "Endpoints to manage campaigns via the REST API." + }, + { + "name": "projects", + "description": "Endpoints to manage Projects using the REST API." } ], "servers": [ @@ -26054,6 +26058,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -41194,6 +41222,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -46970,6 +47022,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -50599,17 +50675,17 @@ } } }, - "/organizations/{org}/dependabot/repository-access": { + "/organizations/{org}/actions/permissions/artifact-and-log-retention": { "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.", + "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": [ - "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/permissions#get-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -50620,29 +50696,6 @@ "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": { @@ -50651,523 +50704,28 @@ "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": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal", - "nullable": true + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" }, - "accessible_repositories": { - "type": "array", - "items": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "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" - ], - "nullable": true - } + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" } }, - "additionalProperties": false + "required": [ + "days", + "maximum_allowed_days" + ] }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "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" - } - ] + "days": 90, + "maximum_allowed_days": 365 } } } @@ -51228,22 +50786,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } }, - "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```", + "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": [ - "dependabot" + "actions" ], - "operationId": "dependabot/update-repository-access-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/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -51263,50 +50820,19 @@ "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." + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" } }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } + "required": [ + "days" + ] }, "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", + "application/json": { "value": { - "repository_ids_to_remove": [ - 789 - ] + "days": 100 } } } @@ -51315,7 +50841,7 @@ }, "responses": { "204": { - "description": "Response" + "description": "No content" }, "403": { "description": "Forbidden", @@ -51368,77 +50894,9 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" - } - } - }, - "/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": [ - "dependabot" - ], - "operationId": "dependabot/set-repository-access-default-level", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" - }, - "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": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal" - } - }, - "required": [ - "default_level" - ] - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", - "value": { - "default_level": "public" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -51463,14 +50921,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -51478,11 +50940,50 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -51491,24 +50992,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } } }, - "/organizations/{org}/settings/billing/usage": { + "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { "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).\"", + "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": [ - "billing" + "actions" ], - "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" + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -51519,144 +51019,42 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { "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" - ] - } + "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": { - "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" - } - ] + "approval_policy": "first_time_contributors" } } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -51678,45 +51076,44 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } + } + }, + "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" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -51741,14 +51138,18 @@ } } }, - "500": { - "description": "Internal Error", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -51756,33 +51157,83 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "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" } } } @@ -51790,24 +51241,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "billing", - "subcategory": "enhanced-billing" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}": { + "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { "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 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": [ - "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-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -51826,438 +51276,65 @@ "content": { "application/json": { "schema": { - "title": "Organization Full", - "description": "Organization Full", "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": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true, - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "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", - "nullable": true - }, - "default_repository_branch": { - "type": "string", - "example": "main", - "nullable": true, - "description": "The default branch for repositories created in this organization." - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_delete_repositories": { - "type": "boolean", - "example": true - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "example": true - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "example": true - }, - "members_can_delete_issues": { - "type": "boolean", - "example": true - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "example": true - }, - "readers_can_create_discussions": { - "type": "boolean", - "example": true - }, - "members_can_create_teams": { - "type": "boolean", - "example": true - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { + "run_workflows_from_fork_pull_requests": { "type": "boolean", - "example": false, - "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.", - "deprecated": true + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "secret_scanning_push_protection_enabled_for_new_repositories": { + "send_write_tokens_to_workflows": { "type": "boolean", - "example": false, - "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.", - "deprecated": true + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "secret_scanning_push_protection_custom_link_enabled": { + "send_secrets_and_variables": { "type": "boolean", - "example": false, - "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", - "example": "https://github.com/test-org/test-repo/blob/main/README.md", - "nullable": true, - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "deploy_keys_enabled_for_repositories": { + "require_approval_for_fork_pr_workflows": { "type": "boolean", - "example": false, - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } - }, - "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": { + "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 + "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": { + "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" } } } @@ -52292,22 +51369,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "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 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": [ - "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-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -52321,171 +51397,40 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], "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": { - "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", - "example": "\"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": { + "run_workflows_from_fork_pull_requests": { "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 + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "secret_scanning_push_protection_enabled_for_new_repositories": { + "send_write_tokens_to_workflows": { "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 + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "secret_scanning_push_protection_custom_link_enabled": { + "send_secrets_and_variables": { "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." + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "deploy_keys_enabled_for_repositories": { + "require_approval_for_fork_pr_workflows": { "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } } }, "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" + "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 } } } @@ -52493,553 +51438,73 @@ } }, "responses": { - "200": { - "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": "Organization Full", - "description": "Organization Full", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true, - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "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", - "nullable": true - }, - "default_repository_branch": { - "type": "string", - "example": "main", - "nullable": true, - "description": "The default branch for repositories created in this organization." - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_delete_repositories": { - "type": "boolean", - "example": true - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "example": true - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "example": true - }, - "members_can_delete_issues": { - "type": "boolean", - "example": true - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "example": true - }, - "readers_can_create_discussions": { - "type": "boolean", - "example": true - }, - "members_can_create_teams": { - "type": "boolean", - "example": true - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "example": false, - "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", - "example": "https://github.com/test-org/test-repo/blob/main/README.md", - "nullable": true, - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true + "type": "string" }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "example": false, - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." - } - }, - "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 + "status": { + "type": "string" } } } } } }, - "422": { - "description": "Validation failed", + "404": { + "description": "Resource not found", "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -53047,11 +51512,50 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -53060,22 +51564,23 @@ } }, "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", + } + }, + "/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": [ - "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#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -53089,23 +51594,45 @@ } ], "responses": { - "202": { - "description": "Accepted", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "type": "object" + "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": { - "default": { - "value": null + "response": { + "summary": "Example response", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } } } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -53130,8 +51657,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -53158,24 +51685,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } - } - }, - "/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.", + }, + "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" ], - "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#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -53188,67 +51712,207 @@ } } ], + "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": { - "200": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_active_caches_count": { - "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." + "message": { + "type": "string" }, - "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." + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - }, - "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 + } + } + } + } + }, + "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" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "409": { + "description": "Conflict", + "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" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/cache/usage-by-repository": { + "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { "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.", + "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" ], - "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#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -53286,304 +51950,739 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repository_cache_usages" - ], "properties": { "total_count": { "type": "integer" }, - "repository_cache_usages": { + "repositories": { "type": "array", "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { "type": "string", - "example": "octo-org/Hello-World" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer", - "example": 2322142 + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "example": 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": "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/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/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": { - "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", + "full_name": { "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 + "example": "octocat/Hello-World" }, - "image_details": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "key": { "type": "string", - "example": "ubuntu-20.04" + "example": "mit" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "name": { + "type": "string", + "example": "MIT License" }, - "display_name": { - "description": "Display name for this image.", + "url": { "type": "string", - "example": 20.04 + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "source": { - "description": "The image provider.", + "spdx_id": { "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "id", - "size_gb", - "display_name", - "source" + "key", + "name", + "url", + "spdx_id", + "node_id" ], "nullable": true }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "example": "8-core" + "example": "octocat" }, - "cpu_cores": { - "description": "The number of cores.", + "id": { "type": "integer", - "example": 8 + "format": "int64", + "example": 1 }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "cpu_cores", - "memory_gb", - "storage_gb" + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "status": { - "description": "The status of the runner.", + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "platform": { - "description": "The operating system of the image.", + "description": { "type": "string", - "example": "linux-x64" + "example": "This your first repo!", + "nullable": true }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { "type": "integer", - "default": 10, - "example": 5 + "example": 9 }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, "type": "boolean", "example": true }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "topics": { "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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } + "type": "string" } }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": "string", "format": "date-time", - "example": "2022-10-09T23:39:01Z", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" + "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" ] } } @@ -53592,89 +52691,207 @@ "examples": { "default": { "value": { - "total_count": 2, - "runners": [ + "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 + "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 }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } + "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" ], - "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 + "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 }, - "machine_size_details": { - "id": "8-core", - "cpu_cores": 8, - "memory_gb": 32, - "storage_gb": 300 + "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" }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" + "forks": 1, + "open_issues": 1, + "watchers": 1 } ] } } } } - }, - "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 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/hosted-runners#create-a-github-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -53693,66 +52910,27 @@ "application/json": { "schema": { "type": "object", + "required": [ + "selected_repository_ids" + ], "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" + "selected_repository_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" } - }, - "required": [ - "name", - "image", - "size", - "runner_group_id" - ] + } }, "examples": { - "default": { + "application/json": { "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 + "selected_repository_ids": [ + 1, + 2, + 3 + ] } } } @@ -53760,336 +52938,149 @@ } }, "responses": { - "201": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 + "message": { + "type": "string" }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true + "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "url": { + "type": "string" }, "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": true + "documentation_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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } + "url": { + "type": "string" }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" + "status": { + "type": "string" } } } } } - } - }, - "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", + }, + "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", - "images" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "images": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", "type": "object", + "required": [ + "code" + ], "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" + "resource": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" + "field": { + "type": "string" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "message": { + "type": "string" }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 + "code": { + "type": "string" }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } ] } - }, - "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" + "subcategory": "permissions" } } }, - "/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", + "/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/hosted-runners#get-partner-images-for-github-hosted-runners-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": [ { @@ -54100,105 +53091,185 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", + "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" + } + } + } + } + } + }, + "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": [ - "total_count", - "images" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "images": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", "type": "object", + "required": [ + "code" + ], "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" + "resource": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" + "field": { + "type": "string" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "message": { + "type": "string" }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 + "code": { + "type": "string" }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } ] } - }, - "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" + "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", + }, + "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/hosted-runners#get-limits-on-github-hosted-runners-for-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": [ { @@ -54209,242 +53280,187 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "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.", - "example": 50 - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "example": 17 - } - }, - "required": [ - "maximum", - "current_usage" - ] - } - }, - "required": [ - "public_ips" - ] - }, - "examples": { - "default": { - "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "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", + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "machine_specs" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 + } + } + } + }, + "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": "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", + }, + "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", - "platforms" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "platforms": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "/organizations/{org}/dependabot/repository-access": { "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": "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": "actions/get-hosted-runner-for-org", + "operationId": "dependabot/repository-access-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/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -54457,12 +53473,26 @@ } }, { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, "schema": { - "type": "integer" + "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 } } ], @@ -54472,1250 +53502,47 @@ "content": { "application/json": { "schema": { - "title": "GitHub-hosted hosted runner", - "description": "A Github-hosted hosted runner.", + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", + "default_level": { "type": "string", - "example": "my-github-hosted-runner" + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal", + "nullable": true }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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": "hosted-runners" - } - }, - "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/hosted-runners#update-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" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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" - } - } - }, - "examples": { - "default": { - "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "hosted-runners" - } - }, - "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": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/hosted-runners#delete-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" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "202": { - "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" - } - } - } - } - } - } - }, - "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", - "content": { - "application/json": { - "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", - "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" - } - } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "oidc" - } - }, - "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.", - "tags": [ - "oidc" - ], - "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" - }, - "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": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", - "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" - } - } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Empty response", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "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": { - "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", - "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" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." - }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] - }, - "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" - } - } - } - } - } - } - }, - "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": { - "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", - "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" - }, - "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/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": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "number" - }, - "repositories": { + "accessible_repositories": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "example": 42, "type": "integer", - "format": "int64" + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." }, "name": { - "description": "The name of the repository.", "type": "string", - "example": "Team Environment" + "example": "Hello-World", + "description": "The name of the repository." }, "full_name": { "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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" - ] + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", @@ -55842,438 +53669,223 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true + "nullable": true, + "description": "The repository description." }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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" - } - } + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." } }, "required": [ @@ -56322,57 +53934,34 @@ "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" - ] + "url" + ], + "nullable": true } } - } + }, + "additionalProperties": false }, "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "default_level": "public", + "accessible_repositories": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", + "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://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", + "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", + "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}", @@ -56383,105 +53972,51 @@ "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 + "site_admin": false, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" }, "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", "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 + "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" } ] } @@ -56489,25 +54024,77 @@ } } } + }, + "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" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" } }, - "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", + "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-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -56520,11 +54107,6 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { "required": true, "content": { @@ -56532,25 +54114,49 @@ "schema": { "type": "object", "properties": { - "selected_repository_ids": { - "description": "List of repository IDs to enable for GitHub Actions.", + "repository_ids_to_add": { "type": "array", "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } + "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": [ - "selected_repository_ids" - ] + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } }, "examples": { - "default": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", "value": { - "selected_repository_ids": [ - 32, - 42 + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 ] } } @@ -56558,25 +54164,82 @@ } } }, + "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "/organizations/{org}/dependabot/repository-access/default-level": { "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": "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#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -56587,273 +54250,90 @@ "schema": { "type": "string" } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "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" + ], + "example": "internal" + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, "responses": { "204": { "description": "Response" - } - }, - "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", - "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" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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", + "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" - } - } - } - }, - "examples": { - "default": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - } - } - } - } - } - } - }, - "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": { + "url": { + "type": "string" + }, + "status": { "type": "string" } } } - }, - "examples": { - "selected_actions": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - } - } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/orgs/{org}/actions/permissions/workflow": { - "get": { - "summary": "Get default workflow permissions for an organization", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-github-actions-default-workflow-permissions-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-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", + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] + "message": { + "type": "string" }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - }, - "required": [ - "default_workflow_permissions", - "can_approve_pull_request_reviews" - ] - }, - "examples": { - "default": { - "summary": "Give read-only permission, and allow approving PRs.", - "value": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -56864,89 +54344,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set default workflow permissions for an organization", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/set-github-actions-default-workflow-permissions-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-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": "Success response" - } - }, - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] - }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - } - }, - "examples": { - "default": { - "summary": "Give read-only permission, and allow approving PRs.", - "value": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/orgs/{org}/actions/runner-groups": { + "/organizations/{org}/settings/billing/usage": { "get": { - "summary": "List self-hosted runner groups for an organization", - "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-self-hosted-runner-groups-for-org", + "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/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" }, "parameters": [ { @@ -56959,116 +54372,111 @@ } }, { - "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).\"", + "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", - "default": 30 + "type": "integer" } }, { - "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).\"", + "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", - "default": 1 + "type": "integer" } }, { - "name": "visible_to_repository", - "description": "Only return runner groups that are allowed to be used by this repository.", + "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": "string" + "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": [ - "total_count", - "runner_groups" - ], "properties": { - "total_count": { - "type": "number" - }, - "runner_groups": { + "usageItems": { "type": "array", "items": { "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" + "date": { + "type": "string", + "description": "Date of the usage line item." }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "product": { + "type": "string", + "description": "Product name." }, - "runners_url": { - "type": "string" + "sku": { + "type": "string", + "description": "SKU name." }, - "hosted_runners_url": { - "type": "string" + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." }, - "inherited": { - "type": "boolean" + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." }, - "inherited_allows_public_repositories": { - "type": "boolean" + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." }, - "allows_public_repositories": { - "type": "boolean" + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false + "organizationName": { + "type": "string", + "description": "Name of the organization." }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "repositoryName": { + "type": "string", + "description": "Name of the repository." } }, "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" ] } } @@ -57077,48 +54485,19 @@ "examples": { "default": { "value": { - "total_count": 3, - "runner_groups": [ - { - "id": 1, - "name": "Default", - "visibility": "all", - "default": true, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [], - "workflow_restrictions_read_only": false - }, - { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "inherited": true, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": true - }, + "usageItems": [ { - "id": 3, - "name": "expensive-hardware", - "visibility": "private", - "default": false, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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" } ] } @@ -57126,212 +54505,134 @@ } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - }, - "post": { - "summary": "Create a self-hosted runner group for an organization", - "description": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/create-self-hosted-runner-group-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-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 group.", - "type": "string" - }, - "visibility": { - "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "type": "string", - "enum": [ - "selected", - "all", - "private" - ], - "default": "all" - }, - "selected_repository_ids": { - "description": "List of repository IDs that can access the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } - }, - "runners": { - "description": "List of runner IDs to add to the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - } - }, - "allows_public_repositories": { - "description": "Whether the runner group can be used by `public` repositories.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + }, + "400": { + "description": "Bad Request", + "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" } - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" } - }, - "required": [ - "name" - ] + } }, - "examples": { - "default": { - "value": { - "name": "Expensive hardware runners", - "visibility": "selected", - "selected_repository_ids": [ - 32, - 91 - ], - "runners": [ - 9, - 2 - ] + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } } } } } - } - }, - "responses": { - "201": { - "description": "Response", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { + "message": { "type": "string" }, - "visibility": { + "documentation_url": { "type": "string" }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "url": { "type": "string" }, - "runners_url": { + "status": { "type": "string" - }, - "hosted_runners_url": { + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { "type": "string" }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", + "documentation_url": { "type": "string" }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" + "url": { + "type": "string" }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false + "message": { + "type": "string" }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - }, - "examples": { - "default": { - "value": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "documentation_url": { + "type": "string" } } } @@ -57340,24 +54641,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "/orgs/{org}": { "get": { - "summary": "Get a self-hosted runner group for an organization", - "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-self-hosted-runner-group-for-org", + "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/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -57368,15 +54669,6 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -57385,91 +54677,464 @@ "content": { "application/json": { "schema": { + "title": "Organization Full", + "description": "Organization Full", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, "id": { - "type": "number" + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, "name": { - "type": "string" + "type": "string", + "example": "github" }, - "visibility": { - "type": "string" + "company": { + "type": "string", + "example": "GitHub" }, - "default": { - "type": "boolean" + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "location": { + "type": "string", + "example": "San Francisco" }, - "runners_url": { - "type": "string" + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" }, - "hosted_runners_url": { - "type": "string" + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "is_verified": { + "type": "boolean", + "example": true }, - "inherited": { - "type": "boolean" + "has_organization_projects": { + "type": "boolean", + "example": true }, - "inherited_allows_public_repositories": { - "type": "boolean" + "has_repository_projects": { + "type": "boolean", + "example": true }, - "allows_public_repositories": { - "type": "boolean" + "public_repos": { + "type": "integer", + "example": 2 }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "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", + "nullable": true + }, + "default_repository_branch": { + "type": "string", + "example": "main", + "nullable": true, + "description": "The default branch for repositories created in this organization." + }, + "members_can_create_repositories": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "two_factor_requirement_enabled": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_delete_repositories": { + "type": "boolean", + "example": true + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "example": true + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "example": true + }, + "members_can_delete_issues": { + "type": "boolean", + "example": true + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "example": true + }, + "readers_can_create_discussions": { + "type": "boolean", + "example": true + }, + "members_can_create_teams": { + "type": "boolean", + "example": true + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "example": false, + "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", + "example": "https://github.com/test-org/test-repo/blob/main/README.md", + "nullable": true, + "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ + "login", + "url", "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "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": { + "default-response": { "value": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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" } } } @@ -57478,22 +55143,22 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" } }, "patch": { - "summary": "Update a self-hosted runner group for an organization", - "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/update-self-hosted-runner-group-for-org", + "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/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -57504,71 +55169,174 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { - "required": true, + "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": { - "description": "Name of the runner group.", - "type": "string" + "type": "string", + "description": "The shorthand name of the company." }, - "visibility": { - "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", + "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": [ - "selected", "all", - "private" + "private", + "none" ] }, - "allows_public_repositories": { - "description": "Whether the runner group can be used by `public` repositories.", + "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 }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "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 }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "blog": { + "type": "string", + "example": "\"http://github.blog\"" }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", + "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", - "nullable": true + "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": [ - "name" - ] + } }, "examples": { "default": { "value": { - "name": "Expensive hardware runners", - "visibility": "selected" + "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" } } } @@ -57581,178 +55349,893 @@ "content": { "application/json": { "schema": { + "title": "Organization Full", + "description": "Organization Full", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, "id": { - "type": "number" + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, "name": { - "type": "string" + "type": "string", + "example": "github" }, - "visibility": { - "type": "string" + "company": { + "type": "string", + "example": "GitHub" }, - "default": { - "type": "boolean" + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "location": { + "type": "string", + "example": "San Francisco" }, - "runners_url": { - "type": "string" + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" }, - "hosted_runners_url": { - "type": "string" + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "is_verified": { + "type": "boolean", + "example": true }, - "inherited": { - "type": "boolean" + "has_organization_projects": { + "type": "boolean", + "example": true }, - "inherited_allows_public_repositories": { - "type": "boolean" + "has_repository_projects": { + "type": "boolean", + "example": true }, - "allows_public_repositories": { - "type": "boolean" + "public_repos": { + "type": "integer", + "example": 2 }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "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", + "nullable": true + }, + "default_repository_branch": { + "type": "string", + "example": "main", + "nullable": true, + "description": "The default branch for repositories created in this organization." + }, + "members_can_create_repositories": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "two_factor_requirement_enabled": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_delete_repositories": { + "type": "boolean", + "example": true + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "example": true + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "example": true + }, + "members_can_delete_issues": { + "type": "boolean", + "example": true + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "example": true + }, + "readers_can_create_discussions": { + "type": "boolean", + "example": true + }, + "members_can_create_teams": { + "type": "boolean", + "example": true + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "example": false, + "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", + "example": "https://github.com/test-org/test-repo/blob/main/README.md", + "nullable": true, + "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ + "login", + "url", "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "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": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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 } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - }, - "delete": { - "summary": "Delete a self-hosted runner group from an organization", - "description": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/delete-self-hosted-runner-group-from-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - } - }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { - "get": { - "summary": "List GitHub-hosted runners in a group for an organization", - "description": "Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-github-hosted-runners-in-group-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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/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": "integer" + "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/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" + } + }, + { + "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": { + "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", + "example": "octo-org/Hello-World" + }, + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", + "example": 2322142 + }, + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", + "example": 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": "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/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" } }, { @@ -57787,7 +56270,7 @@ ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "runners": { "type": "array", @@ -58027,24 +56510,22 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - } - }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { - "get": { - "summary": "List repository access to a self-hosted runner group in an organization", - "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + }, + "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/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -58055,982 +56536,276 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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 - } - }, - { - "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 - } } ], + "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": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "number" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 }, - "repositories": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true }, - "role_name": { + "prefix": { + "description": "The prefix for the public IP.", "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 + "example": "20.80.208.150" }, - "watchers": { + "length": { + "description": "The length of the IP prefix.", "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "example": 28 } - }, - "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" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true } - } + }, + "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 - }, - "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 - }, - "template_repository": { - "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", - "organization": null, - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "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 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": 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==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 } - ] + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -59042,19 +56817,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "put": { - "summary": "Set repository access for a self-hosted runner group in an organization", - "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", + } + }, + "/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/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -59065,74 +56842,105 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "description": "List of repository IDs that can access the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." + "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", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } } } }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 32, - 91 - ] + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { - "put": { - "summary": "Add repository access to a self-hosted runner group in an organization", - "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "/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/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -59143,48 +56951,105 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "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", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 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" + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "delete": { - "summary": "Remove repository access to a self-hosted runner group in an organization", - "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", + } + }, + "/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/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" }, "parameters": [ { @@ -59195,50 +57060,75 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "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.", + "example": 50 + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "example": 17 + } + }, + "required": [ + "maximum", + "current_usage" + ] + } + }, + "required": [ + "public_ips" + ] + }, + "examples": { + "default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "/orgs/{org}/actions/hosted-runners/machine-sizes": { "get": { - "summary": "List self-hosted runners in a group for an organization", - "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "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/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" }, "parameters": [ { @@ -59249,33 +57139,6 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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": { @@ -59287,87 +57150,45 @@ "type": "object", "required": [ "total_count", - "runners" + "machine_specs" ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, - "runners": { + "machine_specs": { "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "example": "8-core" }, - "runner_group_id": { - "description": "The ID of the runner group.", + "cpu_cores": { + "description": "The number of cores.", "type": "integer", - "example": 1 + "example": 8 }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 } }, "required": [ "id", - "name", - "os", - "status", - "busy", - "labels" + "cpu_cores", + "memory_gb", + "storage_gb" ] } } @@ -59376,96 +57197,36 @@ "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] - }, - { - "id": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - ] + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "put": { - "summary": "Set self-hosted runners in a group for an organization", - "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-in-group-for-org", + } + }, + "/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/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -59476,74 +57237,65 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "runners": { - "description": "List of runner IDs to add to the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." + "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" + } } } }, - "required": [ - "runners" - ] - }, - "examples": { - "default": { - "value": { - "runners": [ - 9, - 2 - ] + "examples": { + "default": { + "value": { + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { - "put": { - "summary": "Add a self-hosted runner to a group for an organization", - "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/add-self-hosted-runner-to-group-for-org", + "/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/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -59556,17 +57308,8 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -59575,27 +57318,233 @@ } ], "responses": { - "204": { - "description": "Response" + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } }, - "delete": { - "summary": "Remove a self-hosted runner from a group for an organization", - "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/remove-self-hosted-runner-from-group-for-org", + "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/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -59608,17 +57557,8 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -59626,40 +57566,266 @@ } } ], + "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" + } + } + }, + "examples": { + "default": { + "value": { + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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" + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - } - }, - "/orgs/{org}/actions/runners": { - "get": { - "summary": "List self-hosted runners for an organization", - "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + }, + "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": [ "actions" ], - "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ - { - "name": "name", - "description": "The name of a self-hosted runner.", - "in": "query", - "schema": { - "type": "string" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -59670,214 +57836,237 @@ } }, { - "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", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], "responses": { - "200": { + "202": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "total_count", - "runners" - ], "properties": { - "total_count": { - "type": "integer" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 }, - "runners": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true }, - "status": { - "description": "The status of the runner.", + "prefix": { + "description": "The prefix for the public IP.", "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } + "example": "20.80.208.150" }, - "ephemeral": { - "type": "boolean" + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true } - } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] }, "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] - }, + "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": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] + "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, + "enabledForGitHubApps": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runners/downloads": { + "/orgs/{org}/actions/oidc/customization/sub": { "get": { - "summary": "List runner applications for an organization", - "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "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": [ - "actions" + "oidc" ], - "operationId": "actions/list-runner-applications-for-org", + "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" + "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -59892,78 +58081,34 @@ ], "responses": { "200": { - "description": "Response", + "description": "A JSON serialized template for OIDC subject claim customization", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Runner Application", - "description": "Runner Application", - "type": "object", - "properties": { - "os": { - "type": "string" - }, - "architecture": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "filename": { - "type": "string" - }, - "temp_download_token": { - "description": "A short lived bearer token used to download the runner, if needed.", - "type": "string" - }, - "sha256_checksum": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", + "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" } - }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] - } + } + }, + "required": [ + "include_claim_keys" + ] }, "examples": { "default": { - "value": [ - { - "os": "osx", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", - "filename": "actions-runner-osx-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", - "filename": "actions-runner-linux-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "arm", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm-2.164.0.tar.gz" - }, - { - "os": "win", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", - "filename": "actions-runner-win-x64-2.164.0.zip" - }, - { - "os": "linux", - "architecture": "arm64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" - } - ] + "value": { + "include_claim_keys": [ + "repo", + "context" + ] + } } } } @@ -59971,24 +58116,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "oidc" } - } - }, - "/orgs/{org}/actions/runners/generate-jitconfig": { - "post": { - "summary": "Create configuration for a just-in-time runner for an organization", - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + }, + "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.", "tags": [ - "actions" + "oidc" ], - "operationId": "actions/generate-runner-jitconfig-for-org", + "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -60006,49 +58148,29 @@ "content": { "application/json": { "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", - "required": [ - "name", - "runner_group_id", - "labels" - ], "properties": { - "name": { - "type": "string", - "description": "The name of the new runner." - }, - "runner_group_id": { - "type": "integer", - "description": "The ID of the runner group to register the runner to." - }, - "labels": { + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", "type": "array", - "minItems": 1, - "maxItems": 100, "items": { "type": "string" - }, - "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." - }, - "work_folder": { - "type": "string", - "description": "The working directory to be used for job execution, relative to the runner install directory.", - "default": "_work" + } } - } + }, + "required": [ + "include_claim_keys" + ] }, "examples": { "default": { "value": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -60057,131 +58179,19 @@ }, "responses": { "201": { - "description": "Response", + "description": "Empty response", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "required": [ - "runner", - "encoded_jit_config" - ], - "properties": { - "runner": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - }, - "encoded_jit_config": { - "type": "string", - "description": "The base64 encoded runner configuration." - } - } + "properties": {}, + "additionalProperties": false }, "examples": { "default": { - "value": { - "runner": { - "id": 23, - "name": "New runner", - "os": "unknown", - "status": "offline", - "busy": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - }, - "encoded_jit_config": "abc123" - } + "value": null } } } @@ -60213,18 +58223,14 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -60232,37 +58238,94 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - }, - "409": { - "description": "Conflict", + } + }, + "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", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" + "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" + ] }, - "documentation_url": { - "type": "string" + "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`." }, - "url": { - "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" + ] }, - "status": { - "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" } } } @@ -60271,24 +58334,99 @@ } }, "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": "self-hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runners/registration-token": { - "post": { - "summary": "Create a registration token for an organization", - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/orgs/{org}/actions/permissions/repositories": { + "get": { + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\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" ], - "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -60299,38 +58437,42 @@ "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": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", + "required": [ + "total_count", + "repositories" + ], "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "example": "v1.1f699f1069f60xxx" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "example": "2016-07-11T22:14:10Z" - }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - } + "total_count": { + "type": "number" }, "repositories": { - "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", @@ -61061,57 +59203,319 @@ "updated_at" ] } - }, - "single_file": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] } - }, - "required": [ - "token", - "expires_at" - ] + } }, "examples": { "default": { "value": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" + "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 + } + ] + } + } + } + } + } + } + }, + "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", + "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" + }, + "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": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." } } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] + } } } } } }, "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\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/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "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", + "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" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runners/remove-token": { - "post": { - "summary": "Create a remove token for an organization", - "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/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" ], - "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" + "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -61125,138 +59529,1459 @@ } ], "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "example": "v1.1f699f1069f60xxx" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "example": "2016-07-11T22:14:10Z" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - } + "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." }, - "repositories": { - "description": "The repositories this token has access to", + "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": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "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": { + "type": "string" + } + } + } + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/workflow": { + "get": { + "summary": "Get default workflow permissions for an organization", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-github-actions-default-workflow-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-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": { + "default_workflow_permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] + }, + "can_approve_pull_request_reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + } + }, + "required": [ + "default_workflow_permissions", + "can_approve_pull_request_reviews" + ] + }, + "examples": { + "default": { + "summary": "Give read-only permission, and allow approving PRs.", + "value": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set default workflow permissions for an organization", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-github-actions-default-workflow-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-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": "Success response" + } + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_workflow_permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] + }, + "can_approve_pull_request_reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + } + } + }, + "examples": { + "default": { + "summary": "Give read-only permission, and allow approving PRs.", + "value": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an organization", + "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runner-groups-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-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/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 + } + }, + { + "name": "visible_to_repository", + "description": "Only return runner groups that are allowed to be used by this repository.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runner_groups" + ], + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [], + "workflow_restrictions_read_only": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": true, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "post": { + "summary": "Create a self-hosted runner group for an organization", + "description": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-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 group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an organization", + "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "patch": { + "summary": "Update a self-hosted runner group for an organization", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ] + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an organization", + "description": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + "get": { + "summary": "List GitHub-hosted runners in a group for an organization", + "description": "Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-github-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "number" + }, + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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 + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + "get": { + "summary": "List repository access to a self-hosted runner group in an organization", + "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, "email": { "nullable": true, @@ -61374,8 +61099,6 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -61470,8 +61193,7 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "type": "string" }, "issue_comment_url": { "type": "string", @@ -61520,8 +61242,7 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "type": "string" }, "stargazers_url": { "type": "string", @@ -61557,13 +61278,10 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "type": "string" }, "mirror_url": { "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -61572,14 +61290,10 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "type": "string" }, "homepage": { "type": "string", - "format": "uri", - "example": "https://github.com", "nullable": true }, "language": { @@ -61587,36 +61301,26 @@ "nullable": true }, "forks_count": { - "type": "integer", - "example": 9 + "type": "integer" }, "stargazers_count": { - "type": "integer", - "example": 80 + "type": "integer" }, "watchers_count": { - "type": "integer", - "example": 80 + "type": "integer" }, "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", - "example": 108 + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" + "type": "string" }, "open_issues_count": { - "type": "integer", - "example": 0 + "type": "integer" }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true + "type": "boolean" }, "topics": { "type": "array", @@ -61625,51 +61329,30 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true + "type": "boolean" }, "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true + "type": "boolean" }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "type": "boolean" }, "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", "type": "string" }, "pushed_at": { @@ -61690,122 +61373,214 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" }, "temp_clone_token": { "type": "string" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false + "type": "boolean" }, - "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", - "example": false + "subscribers_count": { + "type": "integer" }, - "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 + "network_count": { + "type": "integer" }, - "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)." + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] }, - "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." + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true }, - "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)." + "forks": { + "type": "integer", + "example": 0 }, - "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." + "open_issues": { + "type": "integer", + "example": 0 }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true + "watchers": { + "type": "integer", + "example": 0 }, "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", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "example": false }, - "code_search_index_status": { + "security_and_analysis": { + "nullable": true, "type": "object", - "description": "The status of the code search index for this repository", "properties": { - "lexical_search_ok": { - "type": "boolean" + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "lexical_commit_sha": { - "type": "string" + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -61854,292 +61629,259 @@ "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" + "url" ] } - }, - "single_file": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - } - }, - "required": [ - "token", - "expires_at" - ] - }, - "examples": { - "default": { - "value": { - "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-29T12:13:35.123-08:00" } } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/orgs/{org}/actions/runners/{runner_id}": { - "get": { - "summary": "Get a self-hosted runner for an organization", - "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/get-self-hosted-runner-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-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" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] }, "examples": { "default": { "value": { - "id": 23, - "name": "MBP", - "os": "macos", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, + "total_count": 1, + "repositories": [ { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - }, - "delete": { - "summary": "Delete a self-hosted runner from an organization", - "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-self-hosted-runner-from-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "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" - } + "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 + }, + "template_repository": { + "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", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "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 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": 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==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] } } } @@ -62148,24 +61890,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - } - }, - "/orgs/{org}/actions/runners/{runner_id}/labels": { - "get": { - "summary": "List labels for a self-hosted runner for an organization", - "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + }, + "put": { + "summary": "Set repository access for a self-hosted runner group in an organization", + "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], - "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -62178,8 +61918,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -62187,128 +61927,115 @@ } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." } } }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 91 + ] } } } } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + "put": { + "summary": "Add repository access to a self-hosted runner group in an organization", + "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "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" - } - } - } - } + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } + ], + "responses": { + "204": { + "description": "Response" + } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } }, - "post": { - "summary": "Add custom labels to a self-hosted runner for an organization", - "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "delete": { + "summary": "Remove repository access to a self-hosted runner group in an organization", + "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], - "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -62321,8 +62048,17 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { @@ -62330,40 +62066,69 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "labels" - ], - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "maxItems": 100, - "description": "The names of the custom labels to add to the runner.", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "labels": [ - "gpu", - "accelerated" - ] - } - } - } - } + "responses": { + "204": { + "description": "Response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an organization", + "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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", @@ -62373,38 +62138,87 @@ "type": "object", "required": [ "total_count", - "labels" + "runners" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "labels": { + "runners": { "type": "array", "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { "id": { + "description": "The ID of the runner.", "type": "integer", - "description": "Unique identifier of the label." + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 }, "name": { + "description": "The name of the runner.", "type": "string", - "description": "Name of the label." + "example": "iMac" }, - "type": { + "os": { + "description": "The Operating System of the runner.", "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } }, "required": [ - "name" + "id", + "name", + "os", + "status", + "busy", + "labels" ] } } @@ -62413,109 +62227,96 @@ "examples": { "default": { "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, + "total_count": 2, + "runners": [ { - "id": 20, - "name": "macOS", - "type": "read-only" + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] }, { - "id": 21, - "name": "no-gpu", - "type": "custom" + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } ] } } } } - } - }, - "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": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "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" - } - } - } + "type": "string" } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } }, "put": { - "summary": "Set custom labels for a self-hosted runner for an organization", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "Set self-hosted runners in a group for an organization", + "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-in-group-for-org", "tags": [ "actions" ], - "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -62528,8 +62329,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -62543,27 +62344,26 @@ "application/json": { "schema": { "type": "object", - "required": [ - "labels" - ], "properties": { - "labels": { + "runners": { + "description": "List of runner IDs to add to the runner group.", "type": "array", - "minItems": 0, - "maxItems": 100, - "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", "items": { - "type": "string" + "type": "integer", + "description": "Unique identifier of the runner." } } - } + }, + "required": [ + "runners" + ] }, "examples": { "default": { "value": { - "labels": [ - "gpu", - "accelerated" + "runners": [ + 9, + 2 ] } } @@ -62572,157 +62372,29 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - }, - "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 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" - } - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - }, - "delete": { - "summary": "Remove all custom labels from a self-hosted runner for an organization", - "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an organization", + "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-self-hosted-runner-to-group-for-org", "tags": [ "actions" ], - "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" }, "parameters": [ { @@ -62734,6 +62406,15 @@ "type": "string" } }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", @@ -62745,124 +62426,27 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 3, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - } - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - } - }, - "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + }, "delete": { - "summary": "Remove a custom label from a self-hosted runner for an organization", - "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "Remove a self-hosted runner from a group for an organization", + "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-self-hosted-runner-from-group-for-org", "tags": [ "actions" ], - "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" }, "parameters": [ { @@ -62875,8 +62459,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -62884,171 +62468,49 @@ } }, { - "name": "name", - "description": "The name of a self-hosted runner's custom label.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - }, - "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 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" - } - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/orgs/{org}/actions/secrets": { + "/orgs/{org}/actions/runners": { "get": { - "summary": "List organization secrets", - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "List self-hosted runners for an organization", + "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/list-org-secrets", + "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#list-organization-secrets" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" }, "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -63086,52 +62548,87 @@ "type": "object", "required": [ "total_count", - "secrets" + "runners" ], "properties": { "total_count": { "type": "integer" }, - "secrets": { + "runners": { "type": "array", "items": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" + "description": "The name of the runner.", + "type": "string", + "example": "iMac" }, - "created_at": { + "os": { + "description": "The Operating System of the runner.", "type": "string", - "format": "date-time" + "example": "macos" }, - "updated_at": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "date-time" + "example": "online" }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" + "busy": { + "type": "boolean" }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } }, "required": [ + "id", "name", - "created_at", - "updated_at", - "visibility" + "os", + "status", + "busy", + "labels" ] } } @@ -63140,26 +62637,62 @@ "examples": { "default": { "value": { - "total_count": 3, - "secrets": [ - { - "name": "GIST_ID", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, + "total_count": 2, + "runners": [ { - "name": "DEPLOY_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] }, { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } ] } @@ -63181,21 +62714,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/public-key": { + "/orgs/{org}/actions/runners/downloads": { "get": { - "summary": "Get an organization public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "summary": "List runner applications for an organization", + "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/get-org-public-key", + "operationId": "actions/list-runner-applications-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" }, "parameters": [ { @@ -63214,48 +62747,74 @@ "content": { "application/json": { "schema": { - "title": "ActionsPublicKey", - "description": "The public key used for setting Actions Secrets.", - "type": "object", - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "example": "1234567" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - }, - "id": { - "type": "integer", - "example": 2 - }, - "url": { - "type": "string", - "example": "https://api.github.com/user/keys/2" - }, - "title": { - "type": "string", - "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + "type": "array", + "items": { + "title": "Runner Application", + "description": "Runner Application", + "type": "object", + "properties": { + "os": { + "type": "string" + }, + "architecture": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "temp_download_token": { + "description": "A short lived bearer token used to download the runner, if needed.", + "type": "string" + }, + "sha256_checksum": { + "type": "string" + } }, - "created_at": { - "type": "string", - "example": "2011-01-26T19:01:12Z" - } - }, - "required": [ - "key_id", - "key" - ] + "required": [ + "os", + "architecture", + "download_url", + "filename" + ] + } }, "examples": { "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } + "value": [ + { + "os": "osx", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", + "filename": "actions-runner-osx-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", + "filename": "actions-runner-linux-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "arm", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm-2.164.0.tar.gz" + }, + { + "os": "win", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", + "filename": "actions-runner-win-x64-2.164.0.zip" + }, + { + "os": "linux", + "architecture": "arm64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" + } + ] } } } @@ -63266,119 +62825,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/orgs/{org}/actions/runners/generate-jitconfig": { + "post": { + "summary": "Create configuration for a just-in-time runner for an organization", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/create-or-update-org-secret", + "operationId": "actions/generate-runner-jitconfig-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" }, "parameters": [ { @@ -63389,15 +62850,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -63406,49 +62858,48 @@ "application/json": { "schema": { "type": "object", + "required": [ + "name", + "runner_group_id", + "labels" + ], "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { + "name": { "type": "string", - "description": "ID of the key you used to encrypt the secret." + "description": "The name of the new runner." }, - "visibility": { - "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "enum": [ - "all", - "private", - "selected" - ] + "runner_group_id": { + "type": "integer", + "description": "The ID of the runner group to register the runner to." }, - "selected_repository_ids": { + "labels": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "minItems": 1, + "maxItems": 100, "items": { - "type": "integer" - } + "type": "string" + }, + "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." + }, + "work_folder": { + "type": "string", + "description": "The working directory to be used for job execution, relative to the runner install directory.", + "default": "_work" } - }, - "required": [ - "encrypted_value", - "key_id", - "visibility" - ] + } }, "examples": { "default": { "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" } } } @@ -63457,90 +62908,238 @@ }, "responses": { "201": { - "description": "Response when creating a secret", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } }, "examples": { "default": { - "value": null + "value": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + } } } } } }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "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" + } + } + } + } } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } } - } - ], - "responses": { - "204": { - "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/{secret_name}/repositories": { - "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "/orgs/{org}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for an organization", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/list-selected-repos-for-org-secret", + "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" }, "parameters": [ { @@ -63551,79 +63150,138 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 - } } ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } }, "repositories": { + "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { "nullable": true, "type": "string" @@ -63744,6 +63402,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -63838,7 +63498,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string" + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", @@ -63887,7 +63548,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string" + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", @@ -63923,10 +63585,13 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string" + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -63935,10 +63600,14 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", + "format": "uri", + "example": "https://github.com", "nullable": true }, "language": { @@ -63946,26 +63615,36 @@ "nullable": true }, "forks_count": { - "type": "integer" + "type": "integer", + "example": 9 }, "stargazers_count": { - "type": "integer" + "type": "integer", + "example": 80 }, "watchers_count": { - "type": "integer" + "type": "integer", + "example": 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" + "type": "integer", + "example": 108 }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "example": "master" }, "open_issues_count": { - "type": "integer" + "type": "integer", + "example": 0 }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true }, "topics": { "type": "array", @@ -63974,30 +63653,51 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -64018,214 +63718,122 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, "delete_branch_on_merge": { - "type": "boolean" + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "subscribers_count": { - "type": "integer" + "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", + "example": false }, - "network_count": { - "type": "integer" + "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 }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] + "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)." }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true + "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." }, - "forks": { - "type": "integer", - "example": 0 + "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)." }, - "open_issues": { - "type": "integer", - "example": 0 + "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." }, - "watchers": { - "type": "integer", - "example": 0 + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": 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", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { "type": "boolean", - "example": false + "description": "Whether anonymous git access is enabled for this repository" }, - "security_and_analysis": { - "nullable": true, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_search_ok": { + "type": "boolean" }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_commit_sha": { + "type": "string" } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ @@ -64274,809 +63882,87 @@ "tags_url", "teams_url", "trees_url", - "url" - ] - } - } - } - }, - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/set-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "integer" - } - } - }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/add-selected-repo-to-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "No Content when repository was added to the selected list" - }, - "409": { - "description": "Conflict when visibility type is not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/remove-selected-repo-from-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response when repository was removed from the selected list" - }, - "409": { - "description": "Conflict when visibility type not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/actions/variables": { - "get": { - "summary": "List organization variables", - "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/list-org-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#list-organization-variables" - }, - "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 30). 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": 10 - } - }, - { - "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": { - "type": "object", - "required": [ - "total_count", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "example": "USERNAME", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "example": "octocat", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a variable", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" - } - }, - "required": [ - "name", - "value", + "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", - "visibility" + "updated_at" ] } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 3, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "ACTIONS_RUNNER_DEBUG", - "value": true, - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "ADMIN_EMAIL", - "value": "octocat@github.com", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "post": { - "summary": "Create an organization variable", - "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/create-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#create-an-organization-variable" - }, - "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": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - }, - "visibility": { - "type": "string", - "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", - "items": { - "type": "integer" - } - } - }, - "required": [ - "name", - "value", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a variable", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - } - }, - "/orgs/{org}/actions/variables/{name}": { - "get": { - "summary": "Get an organization variable", - "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#get-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "example": "USERNAME", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "example": "octocat", - "type": "string" }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", + "single_file": { "type": "string", - "format": "date-time" + "example": "config.yaml", + "nullable": true }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a variable", "enum": [ "all", - "private", "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" + ] } }, "required": [ - "name", - "value", - "created_at", - "updated_at", - "visibility" + "token", + "expires_at" ] }, "examples": { "default": { "value": { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "patch": { - "summary": "Update an organization variable", - "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/update-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#update-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - }, - "visibility": { - "type": "string", - "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", - "items": { - "type": "integer" + "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-22T12:13:35.123-08:00" } } } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "delete": { - "summary": "Delete an organization variable", - "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#delete-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/variables/{name}/repositories": { - "get": { - "summary": "List selected repositories for an organization variable", - "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "/orgs/{org}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for an organization", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/list-selected-repos-for-org-variable", + "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" }, "parameters": [ { @@ -65087,74 +63973,133 @@ "schema": { "type": "string" } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 - } } ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } }, "repositories": { + "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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.", @@ -65280,6 +64225,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -65374,7 +64321,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string" + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", @@ -65423,7 +64371,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string" + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", @@ -65459,10 +64408,13 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string" + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -65471,10 +64423,14 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", + "format": "uri", + "example": "https://github.com", "nullable": true }, "language": { @@ -65482,26 +64438,36 @@ "nullable": true }, "forks_count": { - "type": "integer" + "type": "integer", + "example": 9 }, "stargazers_count": { - "type": "integer" + "type": "integer", + "example": 80 }, "watchers_count": { - "type": "integer" + "type": "integer", + "example": 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" + "type": "integer", + "example": 108 }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "example": "master" }, "open_issues_count": { - "type": "integer" + "type": "integer", + "example": 0 }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true }, "topics": { "type": "array", @@ -65510,30 +64476,51 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -65554,214 +64541,122 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, "delete_branch_on_merge": { - "type": "boolean" + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "subscribers_count": { - "type": "integer" + "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", + "example": false }, - "network_count": { - "type": "integer" + "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 }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] + "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)." }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true + "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." }, - "forks": { - "type": "integer", - "example": 0 + "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)." }, - "open_issues": { - "type": "integer", - "example": 0 + "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." }, - "watchers": { - "type": "integer", - "example": 0 + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": 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", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { "type": "boolean", - "example": false + "description": "Whether anonymous git access is enabled for this repository" }, - "security_and_analysis": { - "nullable": true, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_search_ok": { + "type": "boolean" }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_commit_sha": { + "type": "string" } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ @@ -65810,114 +64705,87 @@ "tags_url", "teams_url", "trees_url", - "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" ] } + }, + "single_file": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] } - } + }, + "required": [ + "token", + "expires_at" + ] }, "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] + "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-29T12:13:35.123-08:00" } } } } } - }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - }, - "put": { - "summary": "Set selected repositories for an organization variable", - "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for an organization", + "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/set-selected-repos-for-org-variable", + "operationId": "actions/get-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -65930,73 +64798,150 @@ } }, { - "name": "name", - "description": "The name of the variable.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "The IDs of the repositories that can access the organization variable.", - "items": { - "type": "integer" + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } - } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] + "examples": { + "default": { + "value": { + "id": 23, + "name": "MBP", + "os": "macos", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } } } } } } }, - "responses": { - "204": { - "description": "Response" - }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" - } - }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization variable", - "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + }, + "delete": { + "summary": "Delete a self-hosted runner from an organization", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/add-selected-repo-to-org-variable", + "operationId": "actions/delete-self-hosted-runner-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" }, "parameters": [ { @@ -66009,16 +64954,8 @@ } }, { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { @@ -66030,27 +64967,56 @@ "204": { "description": "Response" }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" - } - }, - "x-github": { - "githubCloudOnly": false, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - }, - "delete": { - "summary": "Remove selected repository from an organization variable", - "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runners/{runner_id}/labels": { + "get": { + "summary": "List labels for a self-hosted runner for an organization", + "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/remove-selected-repo-from-org-variable", + "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66063,16 +65029,8 @@ } }, { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { @@ -66081,68 +65039,145 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + } + } + } + } }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" + "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": "variables" + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/attestations/bulk-list": { + }, "post": { - "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "summary": "Add custom labels to a self-hosted runner for an organization", + "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-attestations-bulk", + "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#list-attestations-by-bulk-subject-digests" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" }, "parameters": [ { - "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": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -66152,42 +65187,29 @@ "application/json": { "schema": { "type": "object", + "required": [ + "labels" + ], "properties": { - "subject_digests": { + "labels": { "type": "array", + "minItems": 1, + "maxItems": 100, + "description": "The names of the custom labels to add to the runner.", "items": { "type": "string" - }, - "description": "List of subject digests to fetch attestations for.", - "minItems": 1, - "maxItems": 1024 - }, - "predicate_type": { - "type": "string", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types." + } } - }, - "required": [ - "subject_digests" - ] + } }, "examples": { "default": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" + "labels": [ + "gpu", + "accelerated" ] } - }, - "withPredicateType": { - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ], - "predicateType": "provenance" - } } } } @@ -66200,198 +65222,69 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "attestations_subject_digests": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "array", - "items": { - "type": "object", - "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The bundle of the attestation." - }, - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - } - } - } - }, - "description": "Mapping of subject digest to bundles." + "total_count": { + "type": "integer" }, - "page_info": { - "type": "object", - "properties": { - "has_next": { - "type": "boolean", - "description": "Indicates whether there is a next page." - }, - "has_previous": { - "type": "boolean", - "description": "Indicates whether there is a previous page." - }, - "next": { - "type": "string", - "description": "The cursor to the next page." + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } }, - "previous": { - "type": "string", - "description": "The cursor to the previous page." - } - }, - "description": "Information about the current page." + "required": [ + "name" + ] + } } } }, "examples": { "default": { "value": { - "attestations_subject_digests": [ + "total_count": 4, + "labels": [ { - "sha256:abc": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" } ] } @@ -66399,27 +65292,81 @@ } } } + }, + "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 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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/attestations/delete-request": { - "post": { - "summary": "Delete attestations in bulk", - "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + }, + "put": { + "summary": "Set custom labels for a self-hosted runner for an organization", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-attestations-bulk", + "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66430,6 +65377,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -66438,58 +65394,27 @@ "application/json": { "schema": { "type": "object", - "oneOf": [ - { - "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } - }, - "required": [ - "subject_digests" - ] - }, - { - "properties": { - "attestation_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of unique IDs associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } - }, - "required": [ - "attestation_ids" - ] - } + "required": [ + "labels" ], - "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + "properties": { + "labels": { + "type": "array", + "minItems": 0, + "maxItems": 100, + "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", + "items": { + "type": "string" + } + } + } }, "examples": { - "by-subject-digests": { - "summary": "Delete by subject digests", - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] - } - }, - "by-attestation-ids": { - "summary": "Delete by attestation IDs", + "default": { "value": { - "attestation_ids": [ - 111, - 222 + "labels": [ + "gpu", + "accelerated" ] } } @@ -66499,7 +65424,81 @@ }, "responses": { "200": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + } + } + } + } }, "404": { "description": "Resource not found", @@ -66526,27 +65525,55 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" + "category": "actions", + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/attestations/digest/{subject_digest}": { + }, "delete": { - "summary": "Delete attestations by subject digest", - "description": "Delete an artifact attestation by subject digest.", + "summary": "Remove all custom labels from a self-hosted runner for an organization", + "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-attestations-by-subject-digest", + "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66559,22 +65586,87 @@ } }, { - "name": "subject_digest", - "description": "Subject Digest", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } } ], "responses": { "200": { - "description": "Response" - }, - "204": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + } + ] + } + } + } + } + } }, "404": { "description": "Resource not found", @@ -66606,22 +65698,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" + "category": "actions", + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/attestations/{attestation_id}": { + "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { "delete": { - "summary": "Delete attestations by ID", - "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.", + "summary": "Remove a custom label from a self-hosted runner for an organization", + "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-attestations-by-id", + "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -66634,24 +65726,104 @@ } }, { - "name": "attestation_id", - "description": "Attestation ID", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" } + }, + { + "name": "name", + "description": "The name of a self-hosted runner's custom label.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { "200": { - "description": "Response" - }, - "204": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + } + } + } + } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -66676,14 +65848,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -66691,11 +65867,11 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -66706,51 +65882,24 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" + "category": "actions", + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/attestations/{subject_digest}": { + "/orgs/{org}/actions/secrets": { "get": { - "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-attestations", + "operationId": "actions/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#list-attestations" + "url": "https://docs.github.com/rest/actions/secrets#list-organization-secrets" }, "parameters": [ - { - "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": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -66761,22 +65910,21 @@ } }, { - "name": "subject_digest", - "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", - "in": "path", - "required": true, + "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": "string" - }, - "x-multi-segment": true + "type": "integer", + "default": 30 + } }, { - "name": "predicate_type", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "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", - "required": false, "schema": { - "type": "string" + "type": "integer", + "default": 1 } } ], @@ -66787,38 +65935,55 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "secrets" + ], "properties": { - "attestations": { + "total_count": { + "type": "integer" + }, + "secrets": { "type": "array", "items": { + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" }, - "repository_id": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time" }, - "bundle_url": { + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" } - } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] } } } @@ -66826,156 +65991,62 @@ "examples": { "default": { "value": { - "attestations": [ + "total_count": 3, + "secrets": [ { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 + "name": "GIST_ID", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" }, { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 + "name": "DEPLOY_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } ] } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/blocks": { + "/orgs/{org}/actions/secrets/public-key": { "get": { - "summary": "List users blocked by an organization", - "description": "List the users blocked by an organization.", + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-blocked-users", + "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization" + "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -66986,24 +66057,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": { @@ -67012,156 +66065,48 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" }, - "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" - ] - } + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] }, "examples": { "default": { - "value": [ - { - "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 - } - ] + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } } } } @@ -67171,22 +66116,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/blocks/{username}": { + "/orgs/{org}/actions/secrets/{secret_name}": { "get": { - "summary": "Check if a user is blocked by an organization", - "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/check-blocked-user", + "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-secret" }, "parameters": [ { @@ -67199,8 +66144,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -67209,29 +66154,58 @@ } ], "responses": { - "204": { - "description": "If the user is blocked" - }, - "404": { - "description": "If the user is not blocked", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", "type": "string" }, - "documentation_url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time" }, - "status": { + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } } } @@ -67242,20 +66216,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } }, "put": { - "summary": "Block a user from an organization", - "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/block-user", + "operationId": "actions/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization" + "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -67268,8 +66242,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -67277,97 +66251,102 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "encrypted_value", + "key_id", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "201": { + "description": "Response when creating a secret", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Empty Object", + "description": "An object without any properties.", "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null } } } } + }, + "204": { + "description": "Response when updating a secret" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } }, "delete": { - "summary": "Unblock a user from an organization", - "description": "Unblocks the given user on behalf of the specified organization.", + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/unblock-user", + "operationId": "actions/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization" + "url": "https://docs.github.com/rest/actions/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -67380,8 +66359,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -67397,22 +66376,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/campaigns": { + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { "get": { - "summary": "List campaigns for an organization", - "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "campaigns" + "actions" ], - "operationId": "campaigns/list-org-campaigns", + "operationId": "actions/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization" + "url": "https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -67424,6 +66403,15 @@ "type": "string" } }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "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).\"", @@ -67441,51 +66429,6 @@ "type": "integer", "default": 30 } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "state", - "description": "If specified, only campaigns with this state will be returned.", - "in": "query", - "required": false, - "schema": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - } - }, - { - "name": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "ends_at", - "published" - ], - "default": "created" - } } ], "responses": { @@ -67494,1780 +66437,775 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 }, - "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } + "email": { + "nullable": true, + "type": "string" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" + "private": { + "type": "boolean" }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] - } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - { - "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 - } - ], - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open" - }, - { - "number": 4, - "created_at": "2024-03-30T12:29:18Z", - "updated_at": "2024-03-30T12:29:18Z", - "name": "Mitre top 10 KEV", - "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.", - "managers": [ - { - "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 - } - ], - "ends_at": "2024-04-30T12:29:18Z", - "closed_at": null, - "state": "open" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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" - } - } - } - } - } - }, - "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": "campaigns", - "subcategory": "campaigns" - } - }, - "post": { - "summary": "Create a campaign for an organization", - "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.", - "tags": [ - "campaigns" - ], - "operationId": "campaigns/create-campaign", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-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", - "additionalProperties": false, - "properties": { - "name": { - "description": "The name of the campaign", - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "description": { - "description": "A description for the campaign", - "type": "string", - "minLength": 1, - "maxLength": 255 - }, - "managers": { - "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", - "type": "array", - "maxItems": 10, - "items": { - "description": "The login of each manager", - "type": "string" - } - }, - "team_managers": { - "description": "The slugs of the teams to set as the campaign managers.", - "type": "array", - "maxItems": 10, - "items": { - "description": "The slug of each team", - "type": "string" - } - }, - "ends_at": { - "description": "The end date and time of the campaign. The date must be in the future.", - "type": "string", - "format": "date-time" - }, - "contact_link": { - "description": "The contact link of the campaign. Must be a URI.", - "type": "string", - "format": "uri", - "nullable": true - }, - "code_scanning_alerts": { - "description": "The code scanning alerts to include in this campaign", - "type": "array", - "minItems": 1, - "items": { - "type": "object", - "additionalProperties": false, - "properties": { - "repository_id": { - "type": "integer", - "description": "The repository id" - }, - "alert_numbers": { - "type": "array", - "description": "The alert numbers", - "minItems": 1, - "items": { - "type": "integer" - } - } - }, - "required": [ - "repository_id", - "alert_numbers" - ] - } - }, - "generate_issues": { - "description": "If true, will automatically generate issues for the campaign. The default is false.", - "type": "boolean", - "default": false - } - }, - "required": [ - "name", - "description", - "ends_at", - "code_scanning_alerts" - ] - }, - "examples": { - "default": { - "value": { - "name": "Critical CodeQL alerts", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - "octocat" - ], - "ends_at": "2024-03-14T00:00:00Z", - "code_scanning_alerts": [ - { - "repository_id": 1296269, - "alert_numbers": [ - 1, - 2 - ] - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "email": { - "nullable": true, - "type": "string" + "fork": { + "type": "boolean" }, - "login": { + "url": { "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "node_id": { + "archive_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "avatar_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "gravatar_id": { + "blobs_url": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "url": { + "branches_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "html_url": { + "collaborators_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "followers_url": { + "comments_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "following_url": { + "commits_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "gists_url": { + "compare_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "starred_url": { + "contents_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "subscriptions_url": { + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "type": { + "git_commits_url": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "starred_at": { + "git_refs_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "user_view_type": { + "git_tags_url": { "type": "string", - "example": "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "slug": { + "git_url": { "type": "string" }, - "description": { + "issue_comment_url": { "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "notification_setting": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "permission": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "url": { + "labels_url": { "type": "string", - "format": "uri" + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "html_url": { + "languages_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "repositories_url": { + "merges_url": { "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] - } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] - }, - "examples": { - "default": { - "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - { - "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 - } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "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": "Unprocessable Entity", - "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" - } - } - } - } - } - }, - "429": { - "description": "Too Many Requests" - }, - "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": "campaigns", - "subcategory": "campaigns" - } - } - }, - "/orgs/{org}/campaigns/{campaign_number}": { - "get": { - "summary": "Get a campaign for an organization", - "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", - "tags": [ - "campaigns" - ], - "operationId": "campaigns/get-campaign-summary", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "campaign_number", - "description": "The campaign number.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "email": { - "nullable": true, - "type": "string" + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "login": { + "notifications_url": { "type": "string", - "example": "octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "node_id": { + "releases_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "avatar_url": { + "ssh_url": { + "type": "string" + }, + "stargazers_url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "gravatar_id": { + "statuses_url": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "url": { + "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "html_url": { + "subscription_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "followers_url": { + "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "following_url": { + "teams_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "gists_url": { + "trees_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "clone_url": { + "type": "string" }, - "subscriptions_url": { + "mirror_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "nullable": true }, - "organizations_url": { + "hooks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "svn_url": { + "type": "string" }, - "events_url": { + "homepage": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "nullable": true }, - "received_events_url": { + "language": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "nullable": true }, - "type": { - "type": "string", - "example": "User" + "forks_count": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "stargazers_count": { + "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "watchers_count": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "example": "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { + "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" }, - "node_id": { + "default_branch": { "type": "string" }, - "name": { - "type": "string" + "open_issues_count": { + "type": "integer" }, - "slug": { + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { "type": "string" }, - "description": { + "pushed_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", "nullable": true }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true }, - "permission": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true }, "permissions": { "type": "object", "properties": { - "pull": { + "admin": { "type": "boolean" }, - "triage": { + "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, - "maintain": { + "triage": { "type": "boolean" }, - "admin": { + "pull": { "type": "boolean" } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" + } }, - "html_url": { + "role_name": { "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "example": "admin" }, - "members_url": { + "temp_clone_token": { "type": "string" }, - "repositories_url": { - "type": "string", - "format": "uri" + "delete_branch_on_merge": { + "type": "boolean" }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { + "key": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "example": "contributor_covenant" }, "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", "type": "string", - "example": "admin" + "example": "Contributor Covenant" }, - "privacy": { - "description": "The level of privacy this team should have", + "url": { "type": "string", - "example": "closed" + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, - "notification_setting": { - "description": "The notification setting the team has set", + "body": { "type": "string", - "example": "notifications_enabled" + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "name": { + "type": "string" }, - "slug": { - "type": "string", - "example": "justice-league" + "spdx_id": { + "type": "string" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", + "url": { + "type": "string" + }, + "node_id": { "type": "string" } }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "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", - "url", - "members_url", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] + } }, "examples": { "default": { "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ + "total_count": 1, + "repositories": [ { - "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 + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } - } - } - } - } - } - }, - "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": "Unprocessable Entity", - "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" + ] } } } @@ -69278,20 +67216,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "actions", + "subcategory": "secrets" } }, - "patch": { - "summary": "Update a campaign", - "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "campaigns" + "actions" ], - "operationId": "campaigns/update-campaign", + "operationId": "actions/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign" + "url": "https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -69304,12 +67242,12 @@ } }, { - "name": "campaign_number", - "description": "The campaign number.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -69319,63 +67257,25 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": false, "properties": { - "name": { - "description": "The name of the campaign", - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "description": { - "description": "A description for the campaign", - "type": "string", - "minLength": 1, - "maxLength": 255 - }, - "managers": { - "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - } - }, - "team_managers": { - "description": "The slugs of the teams to set as the campaign managers.", + "selected_repository_ids": { "type": "array", - "maxItems": 10, + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { - "description": "The slug of each team", - "type": "string" + "type": "integer" } - }, - "ends_at": { - "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "contact_link": { - "description": "The contact link of the campaign. Must be a URI.", - "type": "string", - "format": "uri", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] } - } + }, + "required": [ + "selected_repository_ids" + ] }, "examples": { "default": { "value": { - "name": "Critical CodeQL alerts" + "selected_repository_ids": [ + 64780797 + ] } } } @@ -69383,546 +67283,380 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - } + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/variables": { + "get": { + "summary": "List organization variables", + "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-org-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-organization-variables" + }, + "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 30). 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": 10 + } + }, + { + "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": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" }, - "team_managers": { - "description": "The campaign team managers", + "variables": { "type": "array", "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, "name": { + "description": "The name of the variable.", + "example": "USERNAME", "type": "string" }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { + "value": { + "description": "The value of the variable.", + "example": "octocat", "type": "string" }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", "type": "string", - "format": "uri" + "format": "date-time" }, - "html_url": { + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "format": "date-time" }, - "members_url": { + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" }, - "repositories_url": { + "selected_repositories_url": { "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true + "format": "uri", + "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" } }, "required": [ - "id", - "node_id", - "url", - "members_url", "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" + "value", + "created_at", + "updated_at", + "visibility" ] } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] + } }, "examples": { "default": { "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ + "total_count": 3, + "variables": [ { - "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 + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "ACTIONS_RUNNER_DEBUG", + "value": true, + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "ADMIN_EMAIL", + "value": "octocat@github.com", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } + ] } } } } - } - }, - "400": { - "description": "Bad Request", - "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" } } } - }, - "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": "variables" + } + }, + "post": { + "summary": "Create an organization variable", + "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#create-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } - }, - "422": { - "description": "Unprocessable Entity", - "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": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + }, + "visibility": { + "type": "string", + "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", + "items": { + "type": "integer" } } + }, + "required": [ + "name", + "value", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } } } } - }, - "503": { - "description": "Service unavailable", + } + }, + "responses": { + "201": { + "description": "Response when creating a variable", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null } } } @@ -69932,20 +67666,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "actions", + "subcategory": "variables" } - }, - "delete": { - "summary": "Delete a campaign for an organization", - "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + } + }, + "/orgs/{org}/actions/variables/{name}": { + "get": { + "summary": "Get an organization variable", + "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "campaigns" + "actions" ], - "operationId": "campaigns/delete-campaign", + "operationId": "actions/get-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization" + "url": "https://docs.github.com/rest/actions/variables#get-an-organization-variable" }, "parameters": [ { @@ -69958,60 +67694,79 @@ } }, { - "name": "campaign_number", - "description": "The campaign number.", + "name": "name", + "description": "The name of the variable.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { - "204": { - "description": "Deletion successful" - }, - "404": { - "description": "Resource not found", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the variable.", + "example": "USERNAME", "type": "string" }, - "documentation_url": { + "value": { + "description": "The value of the variable.", + "example": "octocat", "type": "string" }, - "url": { - "type": "string" + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", + "type": "string", + "format": "date-time" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", + "type": "string", + "format": "date-time" }, - "message": { + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" }, - "documentation_url": { - "type": "string" + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" } } } @@ -70022,22 +67777,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "actions", + "subcategory": "variables" } - } - }, - "/orgs/{org}/code-scanning/alerts": { - "get": { - "summary": "List code scanning alerts for an organization", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + }, + "patch": { + "summary": "Update an organization variable", + "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "code-scanning" + "actions" ], - "operationId": "code-scanning/list-alerts-for-org", + "operationId": "actions/update-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/rest/actions/variables#update-an-organization-variable" }, "parameters": [ { @@ -70050,40 +67803,147 @@ } }, { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "query", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." + "type": "string" } - }, + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + }, + "visibility": { + "type": "string", + "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Delete an organization variable", + "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#delete-an-organization-variable" + }, + "parameters": [ { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "nullable": true, - "type": "string", - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + "type": "string" } }, { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}/repositories": { + "get": { + "summary": "List selected repositories for an organization variable", + "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { "type": "string" } @@ -70105,69 +67965,6 @@ "type": "integer", "default": 30 } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "state", - "description": "If specified, only code scanning alerts with this state will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" - ] - } - }, - { - "name": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } - }, - { - "name": "severity", - "description": "If specified, only code scanning alerts with this severity will be returned.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "Severity of a code scanning alert.", - "enum": [ - "critical", - "high", - "medium", - "low", - "warning", - "note", - "error" - ] - } } ], "responses": { @@ -70176,397 +67973,38 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "nullable": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "fixed_at": { - "type": "string", - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "dismissed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "dismissed_at": { - "type": "string", - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "dismissed_reason": { - "type": "string", - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests" - ] - }, - "dismissed_comment": { - "type": "string", - "description": "The dismissal comment associated with the dismissal of the alert.", - "nullable": true, - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "nullable": true, - "type": "string", - "description": "A unique identifier for the rule used to detect the alert." - }, - "name": { - "type": "string", - "description": "The name of the rule used to detect the alert." - }, - "severity": { - "nullable": true, - "type": "string", - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error" - ] - }, - "security_severity_level": { - "nullable": true, - "type": "string", - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - }, - "full_description": { - "type": "string", - "description": "A description of the rule used to detect the alert." - }, - "tags": { - "nullable": true, - "type": "array", - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, - "help": { - "nullable": true, - "type": "string", - "description": "Detailed documentation for the rule as GitHub Flavored Markdown." - }, - "help_uri": { - "nullable": true, - "type": "string", - "description": "A link to the documentation for the rule used to detect the alert." - } - } - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "nullable": true, - "type": "string", - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "nullable": true, - "type": "string", - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - } - }, - "most_recent_instance": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "analysis_key": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." - }, - "environment": { - "type": "string", - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "nullable": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "commit_sha": { - "type": "string" - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "location": { - "type": "object", - "description": "Describe a region within a file for the alert.", - "properties": { - "path": { - "type": "string" - }, - "start_line": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "start_column": { - "type": "integer" - }, - "end_column": { - "type": "integer" - } - } - }, - "html_url": { - "type": "string" - }, - "classifications": { - "type": "array", - "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", - "items": { - "type": "string", - "description": "A classification of the file. For example to identify it as generated.", - "nullable": true, - "enum": [ - "source", - "generated", - "test", - "library" - ] - } - } - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", - "example": "Hello-World", - "description": "The name of the repository." + "example": "Hello-World" }, "full_name": { "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." + "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", @@ -70693,223 +68131,488 @@ ] }, "private": { - "type": "boolean", - "description": "Whether the repository is private." + "type": "boolean" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." + "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true, - "description": "The repository description." + "nullable": true }, "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." + "type": "boolean" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." + "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" }, "issue_comment_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true }, "hooks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -70960,224 +68663,39 @@ "trees_url", "url" ] - }, - "dismissal_approved_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance", - "repository" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "number": 4, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", - "html_url": "https://github.com/octocat/hello-world/code-scanning/4", - "state": "open", - "dismissed_by": null, - "dismissed_at": null, - "dismissed_reason": null, - "dismissed_comment": null, - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", - "repository": { - "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 + } + } + } + }, + "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", @@ -71201,6 +68719,7 @@ "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}", @@ -71212,6 +68731,7 @@ "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", @@ -71219,154 +68739,618 @@ "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}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } + } + } + } + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "put": { + "summary": "Set selected repositories for an organization variable", + "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/set-selected-repos-for-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "The IDs of the repositories that can access the organization variable.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization variable", + "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-selected-repo-to-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Remove selected repository from an organization variable", + "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/attestations/bulk-list": { + "post": { + "summary": "List attestations by bulk subject digests", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-attestations-by-bulk-subject-digests" + }, + "parameters": [ + { + "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": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests to fetch attestations for.", + "minItems": 1, + "maxItems": 1024 + }, + "predicate_type": { + "type": "string", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types." + } + }, + "required": [ + "subject_digests" + ] + }, + "examples": { + "default": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "withPredicateType": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ], + "predicateType": "provenance" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The bundle of the attestation." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } } }, - { - "number": 3, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", - "html_url": "https://github.com/octocat/hello-world/code-scanning/3", - "state": "dismissed", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" + "description": "Mapping of subject digest to bundles." + }, + "page_info": { + "type": "object", + "properties": { + "has_next": { + "type": "boolean", + "description": "Indicates whether there is a next page." }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" + "has_previous": { + "type": "boolean", + "description": "Indicates whether there is a previous page." }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "lib/ab12-gen.js", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [] + "next": { + "type": "string", + "description": "The cursor to the next page." }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", - "repository": { - "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}", - "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}", - "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}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + "previous": { + "type": "string", + "description": "The cursor to the previous page." } - } - ] + }, + "description": "Information about the current page." + } + } + }, + "examples": { + "default": { + "value": { + "attestations_subject_digests": [ + { + "sha256:abc": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/attestations/delete-request": { + "post": { + "summary": "Delete attestations in bulk", + "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk" + }, + "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", + "oneOf": [ + { + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "subject_digests" + ] + }, + { + "properties": { + "attestation_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of unique IDs associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "attestation_ids" + ] + } + ], + "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + }, + "examples": { + "by-subject-digests": { + "summary": "Delete by subject digests", + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "by-attestation-ids": { + "summary": "Delete by attestation IDs", + "value": { + "attestation_ids": [ + 111, + 222 + ] + } } } } + } + }, + "responses": { + "200": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -71393,22 +69377,76 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, + "/orgs/{org}/attestations/digest/{subject_digest}": { + "delete": { + "summary": "Delete attestations by subject digest", + "description": "Delete an artifact attestation by subject digest.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-attestations-by-subject-digest", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "503": { - "description": "Service unavailable", + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "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": { - "code": { - "type": "string" - }, "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -71419,22 +69457,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-scanning", - "subcategory": "code-scanning" + "category": "orgs", + "subcategory": "attestations" } } }, - "/orgs/{org}/code-security/configurations": { - "get": { - "summary": "Get code security configurations for an organization", - "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "/orgs/{org}/attestations/{attestation_id}": { + "delete": { + "summary": "Delete attestations by ID", + "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/get-configurations-for-org", + "operationId": "orgs/delete-attestations-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization" + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id" }, "parameters": [ { @@ -71447,24 +69485,100 @@ } }, { - "name": "target_type", - "in": "query", - "description": "The target type of the code security configuration", - "required": false, + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "global", - "all" - ], - "default": "all" + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "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": "orgs", + "subcategory": "attestations" + } + } + }, + "/orgs/{org}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-attestations" + }, + "parameters": [ { "name": "per_page", - "in": "query", "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).\"", - "required": false, + "in": "query", "schema": { "type": "integer", "default": 30 @@ -71487,6 +69601,260 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/blocks": { + "get": { + "summary": "List users blocked by an organization", + "description": "List the users blocked by an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-blocked-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-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/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": { @@ -71497,346 +69865,206 @@ "schema": { "type": "array", "items": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "description": "A code security configuration", "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] + "nullable": true, + "type": "string" }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "email": { + "nullable": true, + "type": "string" }, - "dependency_graph_autosubmit_action": { + "login": { "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "octocat" }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "dependabot_alerts": { + "node_id": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "MDQ6VXNlcjE=" }, - "dependabot_security_updates": { + "avatar_url": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "code_scanning_default_setup": { + "gravatar_id": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "code_scanning_delegated_alert_dismissal": { + "url": { "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "secret_scanning": { + "html_url": { "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://github.com/octocat" }, - "secret_scanning_push_protection": { + "followers_url": { "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "secret_scanning_delegated_bypass": { + "following_url": { "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "secret_scanning_validity_checks": { + "gists_url": { "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "secret_scanning_non_provider_patterns": { + "starred_url": { "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "secret_scanning_generic_secrets": { + "subscriptions_url": { "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "secret_scanning_delegated_alert_dismissal": { + "organizations_url": { "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "private_vulnerability_reporting": { + "repos_url": { "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "enforcement": { + "events_url": { "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "url": { + "received_events_url": { "type": "string", "format": "uri", - "description": "The URL of the configuration" + "example": "https://api.github.com/users/octocat/received_events" }, - "html_url": { + "type": { "type": "string", - "format": "uri", - "description": "The URL of the configuration" + "example": "User" }, - "created_at": { + "site_admin": { + "type": "boolean" + }, + "starred_at": { "type": "string", - "format": "date-time" + "example": "\"2020-07-09T00:17:55Z\"" }, - "updated_at": { + "user_view_type": { "type": "string", - "format": "date-time" + "example": "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" + ] } }, "examples": { "default": { "value": [ { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_delagated_alert_dismissal": "enabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "enabled", - "secret_scanning_delegated_bypass_options": { - "reviewers": [ - { - "security_configuration_id": 17, - "reviewer_id": 5678, - "reviewer_type": "TEAM" - } - ] - }, - "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "secret_scanning_delegated_alert_dismissal": "not_set", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - }, - { - "id": 1326, - "target_type": "organization", - "name": "High risk settings", - "description": "This is a code security configuration for octo-org high risk repositories", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "enabled", - "code_scanning_default_setup": "enabled", - "code_scanning_delagated_alert_dismissal": "enabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", - "created_at": "2024-05-10T00:00:00Z", - "updated_at": "2024-05-10T00:00:00Z" + "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 } ] } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + } + }, + "/orgs/{org}/blocks/{username}": { + "get": { + "summary": "Check if a user is blocked by an organization", + "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-blocked-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "If the user is blocked" + }, + "404": { + "description": "If the user is not blocked", "content": { "application/json": { "schema": { @@ -71860,15 +70088,62 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + }, + "put": { + "summary": "Block a user from an organization", + "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", + "tags": [ + "orgs" + ], + "operationId": "orgs/block-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "404": { - "description": "Resource not found", + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -71876,11 +70151,50 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -71891,20 +70205,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" } }, - "post": { - "summary": "Create a code security configuration", - "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "delete": { + "summary": "Unblock a user from an organization", + "description": "Unblocks the given user on behalf of the specified organization.", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/create-configuration", + "operationId": "orgs/unblock-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration" + "url": "https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization" }, "parameters": [ { @@ -71915,631 +70229,41 @@ "schema": { "type": "string" } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ], - "default": "disabled" - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "enabled" - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", - "default": false - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "code_scanning_options": { - "type": "object", - "description": "Security Configuration feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "not_set" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ], - "default": "enforced" - } - }, - "required": [ - "name", - "description" - ] - }, - "examples": { - "default": { - "summary": "Example for a code security configuration", - "value": { - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "secret_scanning": "enabled" - } - } - } - } - } - }, "responses": { - "201": { - "description": "Successfully created code security configuration", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" } } }, - "/orgs/{org}/code-security/configurations/defaults": { + "/orgs/{org}/campaigns": { "get": { - "summary": "Get default code security configurations", - "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "List campaigns for an organization", + "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/get-default-configurations", + "operationId": "campaigns/list-org-campaigns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations" + "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization" }, "parameters": [ { @@ -72550,6 +70274,69 @@ "schema": { "type": "string" } + }, + { + "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 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "state", + "description": "If specified, only campaigns with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "ends_at", + "published" + ], + "default": "created" + } } ], "responses": { @@ -72559,379 +70346,487 @@ "application/json": { "schema": { "type": "array", - "description": "A list of default code security configurations", "items": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", "properties": { - "default_for_new_repos": { - "enum": [ - "public", - "private_and_internal", - "all" - ], - "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + "number": { + "type": "integer", + "description": "The number of the newly created campaign" }, - "configuration": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "name": { + "type": "string", + "description": "The campaign name" + }, + "description": { + "type": "string", + "description": "The campaign description" + }, + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." + "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" + ] + } + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", + "nullable": true + }, + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "contact_link": { + "description": "The contact link of the campaign.", + "type": "string", + "format": "uri", + "nullable": true + }, + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" }, - "created_at": { - "type": "string", - "format": "date-time" + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" }, - "updated_at": { - "type": "string", - "format": "date-time" + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" } - } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } - } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] } }, "examples": { "default": { "value": [ { - "default_for_new_repos": "public", - "configuration": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "enabled", - "secret_scanning_delegated_bypass_options": { - "reviewers": [ - { - "security_configuration_id": 1325, - "reviewer_id": 5678, - "reviewer_type": "TEAM" - } - ] - }, - "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open" }, { - "default_for_new_repos": "private_and_internal", - "configuration": { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - } + "number": 4, + "created_at": "2024-03-30T12:29:18Z", + "updated_at": "2024-03-30T12:29:18Z", + "name": "Mitre top 10 KEV", + "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.", + "managers": [ + { + "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 + } + ], + "ends_at": "2024-04-30T12:29:18Z", + "closed_at": null, + "state": "open" } ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -72956,25 +70851,20 @@ } } }, - "404": { - "description": "Resource not found", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -72986,22 +70876,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } - } - }, - "/orgs/{org}/code-security/configurations/detach": { - "delete": { - "summary": "Detach configurations from repositories", - "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + }, + "post": { + "summary": "Create a campaign for an organization", + "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/detach-configuration", + "operationId": "campaigns/create-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" + "url": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization" }, "parameters": [ { @@ -73022,25 +70910,104 @@ "type": "object", "additionalProperties": false, "properties": { - "selected_repository_ids": { + "name": { + "description": "The name of the campaign", + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "description": "A description for the campaign", + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "managers": { + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The login of each manager", + "type": "string" + } + }, + "team_managers": { + "description": "The slugs of the teams to set as the campaign managers.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The slug of each team", + "type": "string" + } + }, + "ends_at": { + "description": "The end date and time of the campaign. The date must be in the future.", + "type": "string", + "format": "date-time" + }, + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", + "type": "string", + "format": "uri", + "nullable": true + }, + "code_scanning_alerts": { + "description": "The code scanning alerts to include in this campaign", "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", "minItems": 1, - "maxItems": 1000, "items": { - "type": "integer", - "description": "Unique identifier of the repository." + "type": "object", + "additionalProperties": false, + "properties": { + "repository_id": { + "type": "integer", + "description": "The repository id" + }, + "alert_numbers": { + "type": "array", + "description": "The alert numbers", + "minItems": 1, + "items": { + "type": "integer" + } + } + }, + "required": [ + "repository_id", + "alert_numbers" + ] } + }, + "generate_issues": { + "description": "If true, will automatically generate issues for the campaign. The default is false.", + "type": "boolean", + "default": false } - } + }, + "required": [ + "name", + "description", + "ends_at", + "code_scanning_alerts" + ] }, "examples": { "default": { - "summary": "Example for detaching repositories from configurations.", "value": { - "selected_repository_ids": [ - 32, - 91 + "name": "Critical CodeQL alerts", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + "octocat" + ], + "ends_at": "2024-03-14T00:00:00Z", + "code_scanning_alerts": [ + { + "repository_id": 1296269, + "alert_numbers": [ + 1, + 2 + ] + } ] } } @@ -73049,62 +71016,445 @@ } }, "responses": { - "204": { - "description": "A header with no content is returned." - }, - "400": { - "description": "Bad Request", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", "properties": { - "message": { - "type": "string" + "number": { + "type": "integer", + "description": "The number of the newly created campaign" }, - "documentation_url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "status": { - "type": "string" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { + "name": { "type": "string", - "nullable": true + "description": "The campaign name" }, - "documentation_url": { + "description": { "type": "string", - "nullable": true + "description": "The campaign description" }, - "detail": { + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + } + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", "nullable": true }, - "status": { - "type": "integer" + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] }, - "scimType": { + "contact_link": { + "description": "The contact link of the campaign.", "type": "string", + "format": "uri", "nullable": true }, - "schemas": { - "type": "array", - "items": { - "type": "string" + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] + } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] + }, + "examples": { + "default": { + "value": { + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 } } } @@ -73112,8 +71462,8 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -73164,8 +71514,8 @@ } } }, - "409": { - "description": "Conflict", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -73189,27 +71539,51 @@ } } } + }, + "429": { + "description": "Too Many Requests" + }, + "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": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } } }, - "/orgs/{org}/code-security/configurations/{configuration_id}": { + "/orgs/{org}/campaigns/{campaign_number}": { "get": { - "summary": "Get a code security configuration", - "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "summary": "Get a campaign for an organization", + "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/get-configuration", + "operationId": "campaigns/get-campaign-summary", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration" + "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization" }, "parameters": [ { @@ -73222,8 +71596,8 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "campaign_number", + "description": "The campaign number.", "in": "path", "required": true, "schema": { @@ -73237,317 +71611,449 @@ "content": { "application/json": { "schema": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", - "description": "A code security configuration", "properties": { - "id": { + "number": { "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] + "description": "The number of the newly created campaign" }, - "dependency_graph": { + "created_at": { "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependency_graph_autosubmit_action": { + "updated_at": { "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependabot_alerts": { + "name": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The campaign name" }, - "dependabot_security_updates": { + "description": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The campaign description" }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } + "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" + ] } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, "required": [ - "reviewer_id", - "reviewer_type" - ], + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", "properties": { - "reviewer_id": { + "id": { + "description": "Unique identifier of the team", "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "example": 1 }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "secret_scanning_delegated_alert_dismissal": { + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "private_vulnerability_reporting": { + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "nullable": true }, - "enforcement": { + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", "type": "string", - "description": "The enforcement status for a security configuration", "enum": [ - "enforced", - "unenforced" + "open", + "closed" ] }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { + "contact_link": { + "description": "The contact link of the campaign.", "type": "string", "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { - "type": "string", - "format": "date-time" + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } - } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] }, "examples": { "default": { "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 + } } } } } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -73572,8 +72078,8 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -73597,25 +72103,46 @@ } } } + }, + "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": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } }, "patch": { - "summary": "Update a code security configuration", - "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "summary": "Update a campaign", + "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/update-configuration", + "operationId": "campaigns/update-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" + "url": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign" }, "parameters": [ { @@ -73628,8 +72155,8 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "campaign_number", + "description": "The campaign number.", "in": "path", "required": true, "schema": { @@ -73646,248 +72173,60 @@ "additionalProperties": false, "properties": { "name": { + "description": "The name of the campaign", "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." + "minLength": 1, + "maxLength": 50 }, "description": { + "description": "A description for the campaign", "type": "string", - "description": "A description of the code security configuration", + "minLength": 1, "maxLength": 255 }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } + "managers": { + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "type": "array", + "maxItems": 10, + "items": { + "type": "string" } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } + "team_managers": { + "description": "The slugs of the teams to set as the campaign managers.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The slug of each team", + "type": "string" } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { + "ends_at": { + "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "private_vulnerability_reporting": { + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "nullable": true }, - "enforcement": { + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", "type": "string", - "description": "The enforcement status for a security configuration", "enum": [ - "enforced", - "unenforced" + "open", + "closed" ] } } }, "examples": { "default": { - "summary": "Example for updating a code security configuration", "value": { - "name": "octo-org recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" + "name": "Critical CodeQL alerts" } } } @@ -73896,362 +72235,451 @@ }, "responses": { "200": { - "description": "Response when a configuration is updated", + "description": "Response", "content": { "application/json": { "schema": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", - "description": "A code security configuration", "properties": { - "id": { + "number": { "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The number of the newly created campaign" }, - "dependency_graph_autosubmit_action": { + "created_at": { "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependabot_alerts": { + "updated_at": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependabot_security_updates": { + "name": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } + "description": "The campaign name" }, - "code_scanning_default_setup": { + "description": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The campaign description" }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } + "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" + ] } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, "required": [ - "reviewer_id", - "reviewer_type" - ], + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", "properties": { - "reviewer_id": { + "id": { + "description": "Unique identifier of the team", "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "example": 1 }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "secret_scanning_delegated_alert_dismissal": { + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "private_vulnerability_reporting": { + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "nullable": true }, - "enforcement": { + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", "type": "string", - "description": "The enforcement status for a security configuration", "enum": [ - "enforced", - "unenforced" + "open", + "closed" ] }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { + "contact_link": { + "description": "The contact link of the campaign.", "type": "string", "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { - "type": "string", - "format": "date-time" + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } - } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] }, "examples": { "default": { "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings v2", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "disabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 + } } } } } } }, - "204": { - "description": "Response when no new updates are made" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" - } - }, - "delete": { - "summary": "Delete a code security configuration", - "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/delete-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "A header with no content is returned." - }, "400": { "description": "Bad Request", "content": { @@ -74275,45 +72703,11 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -74338,8 +72732,8 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -74364,25 +72758,20 @@ } } }, - "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": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -74394,22 +72783,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } - } - }, - "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { - "post": { - "summary": "Attach a configuration to repositories", - "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + }, + "delete": { + "summary": "Delete a campaign for an organization", + "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/attach-configuration", + "operationId": "campaigns/delete-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories" + "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization" }, "parameters": [ { @@ -74422,8 +72809,8 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "campaign_number", + "description": "The campaign number.", "in": "path", "required": true, "schema": { @@ -74431,64 +72818,52 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "scope": { - "type": "string", - "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", - "enum": [ - "all", - "all_without_configurations", - "public", - "private_or_internal", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." + "responses": { + "204": { + "description": "Deletion successful" + }, + "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": [ - "scope" - ] - }, - "examples": { - "default": { - "summary": "Example for attaching a configuration to some repositories", - "value": { - "scope": "selected", - "selected_repository_ids": [ - 32, - 91 - ] - } } } } - } - }, - "responses": { - "202": { - "description": "Accepted", + }, + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } } } } @@ -74498,22 +72873,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } } }, - "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { - "put": { - "summary": "Set a code security configuration as a default for an organization", - "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "/orgs/{org}/code-scanning/alerts": { + "get": { + "summary": "List code scanning alerts for an organization", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ - "code-security" + "code-scanning" ], - "operationId": "code-security/set-configuration-as-default", + "operationId": "code-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -74526,532 +72901,497 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_for_new_repos": { - "type": "string", - "description": "Specify which types of repository this security configuration should be applied to by default.", - "enum": [ - "all", - "none", - "private_and_internal", - "public" - ] - } - } - }, - "examples": { - "default": { - "summary": "Set this configuration to be enabled by default on all new repositories.", - "value": { - "default_for_new_repos": "all" - } - } - } + }, + { + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "query", + "required": false, + "schema": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "state", + "description": "If specified, only code scanning alerts with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "severity", + "description": "If specified, only code scanning alerts with this severity will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Severity of a code scanning alert.", + "enum": [ + "critical", + "high", + "medium", + "low", + "warning", + "note", + "error" + ] } } - }, + ], "responses": { "200": { - "description": "Default successfully changed.", + "description": "Response", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "default_for_new_repos": { - "type": "string", - "description": "Specifies which types of repository this security configuration is applied to by default.", - "enum": [ - "all", - "none", - "private_and_internal", - "public" - ] - }, - "configuration": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "type": "array", + "items": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "nullable": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "fixed_at": { + "type": "string", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "dismissed_at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "security_severity_level": { + "nullable": true, + "type": "string", + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "A description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" } + }, + "help": { + "nullable": true, + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "nullable": true, + "type": "string", + "description": "A link to the documentation for the rule used to detect the alert." } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" } - } - } - } - }, - "examples": { - "default": { - "value": { - "default_for_new_repos": "all", - "configuration": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." }, - "code_scanning_options": { - "allow_advanced": false + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "category": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "nullable": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + } + } } - } - } - } - } - } - } - }, - "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": "code-security", - "subcategory": "configurations" - } - } - }, - "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { - "get": { - "summary": "Get repositories associated with a code security configuration", - "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/get-repositories-for-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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", - "required": false, - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "status", - "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "all" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "description": "Repositories associated with a code security configuration and attachment status", - "properties": { - "status": { - "type": "string", - "description": "The attachment status of the code security configuration on the repository.", - "enum": [ - "attached", - "attaching", - "detached", - "removed", - "enforced", - "failed", - "updating", - "removed_by_enterprise" - ] }, "repository": { "title": "Simple Repository", @@ -75471,96 +73811,416 @@ "trees_url", "url" ] + }, + "dismissal_approved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true } - } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance", + "repository" + ] } }, "examples": { "default": { - "summary": "Example of code security configuration repositories", "value": [ { - "status": "attached", + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "dismissed_comment": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", "repository": { - "value": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } + "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}", + "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}", + "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}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", + "repository": { + "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}", + "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}", + "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}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" } } ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -75585,25 +74245,20 @@ } } }, - "404": { - "description": "Resource not found", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -75615,47 +74270,71 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "code-scanning", + "subcategory": "code-scanning" } } }, - "/orgs/{org}/codespaces": { + "/orgs/{org}/code-security/configurations": { "get": { - "summary": "List codespaces for the organization", - "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get code security configurations for an organization", + "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-in-organization", + "operationId": "code-security/get-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization" + "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization" }, "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "target_type", + "in": "query", + "description": "The target type of the code security configuration", + "required": false, + "schema": { + "type": "string", + "enum": [ + "global", + "all" + ], + "default": "all" + } + }, { "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", + "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).\"", + "required": false, "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).\"", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, "schema": { - "type": "integer", - "default": 1 + "type": "string" } }, { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, "schema": { "type": "string" } @@ -75667,1683 +74346,1433 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "codespaces" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "codespaces": { - "type": "array", - "items": { + "type": "array", + "items": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { "type": "object", - "title": "Codespace", - "description": "A codespace.", + "description": "Feature options for Automatic dependency submission", "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "Automatically generated name of this codespace.", - "type": "string", - "example": "monalisa-octocat-hello-world-g4wpq6h95q" - }, - "display_name": { - "description": "Display name for this codespace.", + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, "type": "string", - "example": "bookish space pancake", - "nullable": true + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", + "runner_label": { + "nullable": true, "type": "string", - "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "nullable": true - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_delagated_alert_dismissal": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 17, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] + }, + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "secret_scanning_delegated_alert_dismissal": "not_set", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "organization", + "name": "High risk settings", + "description": "This is a code security configuration for octo-org high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "code_scanning_delagated_alert_dismissal": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" + } + ] + } + } + } + } + }, + "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": "code-security", + "subcategory": "configurations" + } + }, + "post": { + "summary": "Create a code security configuration", + "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/create-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration" + }, + "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", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ], + "default": "disabled" + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", + "default": false + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_options": { + "type": "object", + "description": "Security Configuration feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "not_set" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" }, - "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" - ] - }, - "billable_owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] + }, + "examples": { + "default": { + "summary": "Example for a code security configuration", + "value": { + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, "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" - ] - }, - "machine": { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", + "reviewer_id", + "reviewer_type" + ], "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "example": "standardLinux" - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "example": "4 cores, 16 GB RAM, 64 GB storage" - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "example": "linux" - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "example": 68719476736 - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "example": 17179869184 - }, - "cpus": { + "reviewer_id": { "type": "integer", - "description": "How many cores are available to the codespace.", - "example": 4 + "description": "The ID of the team or role selected as a bypass reviewer" }, - "prebuild_availability": { + "reviewer_type": { "type": "string", - "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", - "example": "ready", + "description": "The type of the bypass reviewer", "enum": [ - "none", - "ready", - "in_progress" - ], - "nullable": true + "TEAM", + "ROLE" + ] } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ], - "nullable": true + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations", + "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations" + }, + "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": "array", + "description": "A list of default code security configurations", + "items": { + "type": "object", + "properties": { + "default_for_new_repos": { + "enum": [ + "public", + "private_and_internal", + "all" + ], + "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + }, + "configuration": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", + "name": { "type": "string", - "example": ".devcontainer/example/devcontainer.json", - "nullable": true - }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": "boolean", - "example": false, - "nullable": true + "description": "The name of the code security configuration. Must be unique within the organization." }, - "created_at": { + "target_type": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "updated_at": { + "description": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "description": "A description of the code security configuration" }, - "last_used_at": { - "description": "Last known time this codespace was started.", + "advanced_security": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] }, - "state": { - "description": "State of this codespace.", + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", "enum": [ - "Unknown", - "Created", - "Queued", - "Provisioning", - "Available", - "Awaiting", - "Unavailable", - "Deleted", - "Moved", - "Shutdown", - "Archived", - "Starting", - "ShuttingDown", - "Failed", - "Exporting", - "Updating", - "Rebuilding" - ], - "example": "Available", - "type": "string" + "enabled", + "disabled", + "not_set" + ] }, - "url": { - "description": "API URL for this codespace.", + "dependency_graph_autosubmit_action": { "type": "string", - "format": "uri" + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "git_status": { - "description": "Details about the codespace's git repository.", + "dependency_graph_autosubmit_action_options": { "type": "object", + "description": "Feature options for Automatic dependency submission", "properties": { - "ahead": { - "description": "The number of commits the local repository is ahead of the remote.", - "type": "integer", - "example": 0 - }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "example": 0 - }, - "has_unpushed_changes": { - "description": "Whether the local repository has unpushed changes.", - "type": "boolean" - }, - "has_uncommitted_changes": { - "description": "Whether the local repository has uncommitted changes.", - "type": "boolean" - }, - "ref": { - "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", - "type": "string", - "example": "main" + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } }, - "location": { - "description": "The initally assigned location of a new codespace.", + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "example": "WestUs2", - "type": "string" - }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": "integer", - "example": 60, - "nullable": true + "enabled", + "disabled", + "not_set" + ] }, - "web_url": { - "description": "URL to access this codespace on the web.", + "dependabot_security_updates": { "type": "string", - "format": "uri" + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "machines_url": { - "description": "API URL to access available alternate machine types for this codespace.", - "type": "string", - "format": "uri" + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } }, - "start_url": { - "description": "API URL to start this codespace.", + "code_scanning_default_setup": { "type": "string", - "format": "uri" + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "stop_url": { - "description": "API URL to stop this codespace.", + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { "type": "string", - "format": "uri" + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "publish_url": { - "description": "API URL to publish this codespace to a new repository.", + "secret_scanning": { "type": "string", - "format": "uri", - "nullable": true + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", + "secret_scanning_push_protection": { "type": "string", - "format": "uri", - "nullable": true + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "recent_folders": { - "type": "array", - "items": { - "type": "string" - } + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "runtime_constraints": { + "secret_scanning_delegated_bypass_options": { "type": "object", + "description": "Feature options for secret scanning delegated bypass", "properties": { - "allowed_port_privacy_settings": { - "description": "The privacy settings a user can select from when forwarding a port.", + "reviewers": { "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", "items": { - "type": "string" - }, - "nullable": true + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } } } }, - "pending_operation": { - "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", - "type": "boolean", - "nullable": true + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", + "secret_scanning_non_provider_patterns": { "type": "string", - "nullable": true + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "secret_scanning_generic_secrets": { "type": "string", - "nullable": true + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "retention_period_minutes": { - "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", - "type": "integer", - "example": 60, - "nullable": true + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "private_vulnerability_reporting": { "type": "string", - "format": "date-time", - "example": "2011-01-26T20:01:12Z", - "nullable": true + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "last_known_stop_notice": { - "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "enforcement": { "type": "string", - "example": "you've used 100% of your spending limit for Codespaces", - "nullable": true + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } - }, - "required": [ - "id", - "name", - "environment_id", - "owner", - "billable_owner", - "repository", - "machine", - "prebuild", - "created_at", - "updated_at", - "last_used_at", - "state", - "url", - "git_status", - "location", - "idle_timeout_minutes", - "web_url", - "machines_url", - "start_url", - "stop_url", - "pulls_url", - "recent_folders" - ] + } } } } }, "examples": { "default": { - "value": { - "total_count": 3, - "codespaces": [ - { - "id": 1, - "name": "monalisa-octocat-hello-world-g4wpq6h95q", - "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "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 - }, - "billable_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 - }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", - "recent_folders": [] - }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-3f89ada1j3", - "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", - "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 + "value": [ + { + "default_for_new_repos": "public", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false }, - "billable_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 + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "code_scanning_options": { + "allow_advanced": false }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 1325, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] }, - "prebuild": false, - "devcontainer_path": ".devcontainer/foobar/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + { + "default_for_new_repos": "private_and_internal", + "configuration": { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", - "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": [] - }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", - "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 + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null }, - "billable_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 + "code_scanning_options": { + "allow_advanced": false }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", - "recent_folders": [] + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" } - ] - } + } + ] } } } @@ -77352,58 +75781,6 @@ "304": { "description": "Not modified" }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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": { @@ -77459,23 +75836,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/codespaces/access": { - "put": { - "summary": "Manage access control for organization codespaces", - "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/code-security/configurations/detach": { + "delete": { + "summary": "Detach configurations from repositories", + "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/set-codespaces-access", + "operationId": "code-security/detach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces" + "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" }, "parameters": [ { @@ -77488,44 +75865,33 @@ } } ], - "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", + "additionalProperties": false, "properties": { - "visibility": { - "type": "string", - "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.", - "enum": [ - "disabled", - "selected_members", - "all_members", - "all_members_and_outside_collaborators" - ] - }, - "selected_usernames": { + "selected_repository_ids": { "type": "array", - "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.", + "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "minItems": 1, + "maxItems": 1000, "items": { - "type": "string" - }, - "maxItems": 100 + "type": "integer", + "description": "Unique identifier of the repository." + } } - }, - "required": [ - "visibility" - ] + } }, "examples": { "default": { + "summary": "Example for detaching repositories from configurations.", "value": { - "visibility": "selected_members", - "selected_usernames": [ - "johnDoe", - "atomIO" + "selected_repository_ids": [ + 32, + 91 ] } } @@ -77535,16 +75901,10 @@ }, "responses": { "204": { - "description": "Response when successfully modifying permissions." - }, - "304": { - "description": "Not modified" + "description": "A header with no content is returned." }, "400": { - "description": "Users are neither members nor collaborators of this organization." - }, - "404": { - "description": "Resource not found", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -77566,71 +75926,36 @@ } } } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Scim Error", + "description": "Scim Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { - "type": "string" + "type": "string", + "nullable": true }, "documentation_url": { - "type": "string" + "type": "string", + "nullable": true }, - "errors": { + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + "type": "string" } } } @@ -77638,8 +75963,8 @@ } } }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -77663,82 +75988,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" - } - } - }, - "/orgs/{org}/codespaces/access/selected_users": { - "post": { - "summary": "Add users to Codespaces access for an organization", - "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/set-codespaces-access-users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "deprecated": true, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members whose codespaces be billed to the organization.", - "items": { - "type": "string" - }, - "maxItems": 100 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "johnDoe", - "atomIO" - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response when successfully modifying permissions." - }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", @@ -77766,77 +76015,8 @@ } } }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -77864,23 +76044,24 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - }, - "delete": { - "summary": "Remove users from Codespaces access for an organization", - "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}": { + "get": { + "summary": "Get a code security configuration", + "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/delete-codespaces-access-users", + "operationId": "code-security/get-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" + "url": "https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration" }, - "deprecated": true, "parameters": [ { "name": "org", @@ -77890,53 +76071,334 @@ "schema": { "type": "string" } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members whose codespaces should not be billed to the organization.", - "items": { - "type": "string" + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" }, - "maxItems": 100 + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } } }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "johnDoe", - "atomIO" - ] + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } } } } } - } - }, - "responses": { - "204": { - "description": "Response when successfully modifying permissions." }, "304": { "description": "Not modified" }, - "400": { - "description": "Users are neither members nor collaborators of this organization." - }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -77961,77 +76423,8 @@ } } }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -78059,23 +76452,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - } - }, - "/orgs/{org}/codespaces/secrets": { - "get": { - "summary": "List organization secrets", - "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-org-secrets", + "operationId": "code-security/update-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets" + "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" }, "parameters": [ { @@ -78088,224 +76479,605 @@ } }, { - "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", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Codespaces Secret", - "description": "Secrets for a GitHub Codespace.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret", - "example": "SECRET_NAME", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "secrets": [ - { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z", - "visibility": "all" + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } } - ] + } } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] } } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - } - }, - "/orgs/{org}/codespaces/secrets/public-key": { - "get": { - "summary": "Get an organization public key", - "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key" - }, - "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": "Response when a configuration is updated", "content": { "application/json": { "schema": { - "title": "CodespacesPublicKey", - "description": "The public key used for setting Codespaces secrets.", "type": "object", + "description": "A code security configuration", "properties": { - "key_id": { - "description": "The identifier for the key.", + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { "type": "string", - "example": "1234567" + "description": "The name of the code security configuration. Must be unique within the organization." }, - "key": { - "description": "The Base64 encoded public key.", + "target_type": { "type": "string", - "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "id": { - "type": "integer", - "example": 2 + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] }, "url": { "type": "string", - "example": "https://api.github.com/user/keys/2" + "format": "uri", + "description": "The URL of the configuration" }, - "title": { + "html_url": { "type": "string", - "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + "format": "uri", + "description": "The URL of the configuration" }, "created_at": { "type": "string", - "example": "2011-01-26T19:01:12Z" + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } - }, - "required": [ - "key_id", - "key" - ] + } }, "examples": { "default": { "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings v2", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "disabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" } } } } } + }, + "204": { + "description": "Response when no new updates are made" } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - } - }, - "/orgs/{org}/codespaces/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "delete": { + "summary": "Delete a code security configuration", + "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/get-org-secret", + "operationId": "code-security/delete-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret" + "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration" }, "parameters": [ { @@ -78318,199 +77090,105 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "A header with no content is returned." + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "title": "Codespaces Secret", - "description": "Secrets for a GitHub Codespace.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "name": { - "description": "The name of the secret", - "example": "SECRET_NAME", + "message": { "type": "string" }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" + "documentation_url": { + "type": "string" }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", - "enum": [ - "all", - "private", - "selected" - ], + "url": { "type": "string" }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + "status": { + "type": "string" } } } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + }, + "application/scim+json": { "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - }, - "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/create-or-update-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "The ID of the key you used to encrypt the secret." - }, - "visibility": { - "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } } - }, - "required": [ - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } } } } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", + }, + "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" + } } } } } }, - "204": { - "description": "Response when updating a secret" - }, "404": { "description": "Resource not found", "content": { @@ -78537,18 +77215,14 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -78556,50 +77230,11 @@ "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -78609,21 +77244,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach a configuration to repositories", + "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/delete-org-secret", + "operationId": "code-security/attach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret" + "url": "https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories" }, "parameters": [ { @@ -78636,40 +77273,73 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "scope": { + "type": "string", + "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", + "enum": [ + "all", + "all_without_configurations", + "public", + "private_or_internal", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "scope" + ] + }, + "examples": { + "default": { + "summary": "Example for attaching a configuration to some repositories", + "value": { + "scope": "selected", + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", + "202": { + "description": "Accepted", "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" - } + "type": "object" + }, + "examples": { + "default": { + "value": null } } } @@ -78678,23 +77348,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { - "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an organization", + "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-selected-repos-for-org-secret", + "operationId": "code-security/set-configuration-as-default", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" }, "parameters": [ { @@ -78707,71 +77377,558 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 + "type": "integer" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + }, + "configuration": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + } + } + }, + "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": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + "get": { + "summary": "Get repositories associated with a code security configuration", + "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-repositories-for-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "Repositories associated with a code security configuration and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { "type": "integer", "format": "int64", - "example": 1296269 + "example": 1296269, + "description": "A unique identifier of the repository." }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", - "example": "Hello-World" + "example": "Hello-World", + "description": "The name of the repository." }, "full_name": { "type": "string", - "example": "octocat/Hello-World" + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", @@ -78898,488 +78055,223 @@ ] }, "private": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true + "nullable": true, + "description": "The repository description." }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." } }, "required": [ @@ -79436,719 +78328,83 @@ }, "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] - } - } - } - } - } - }, - "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": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - }, - "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/set-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "integer" - } - } - }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "409": { - "description": "Conflict when visibility type not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - } - }, - "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/add-selected-repo-to-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "No Content when repository was added to the selected list" - }, - "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 when visibility type is not set to selected" - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - }, - "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/remove-selected-repo-from-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response when repository was removed from the selected list" - }, - "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 when visibility type not set to selected" - }, - "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" - }, + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } } } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - } - }, - "/orgs/{org}/copilot/billing": { - "get": { - "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/get-copilot-organization-details", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-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": "OK", - "content": { - "application/json": { - "schema": { - "title": "Copilot Organization Details", - "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", - "type": "object", - "properties": { - "seat_breakdown": { - "title": "Copilot Seat Breakdown", - "description": "The breakdown of Copilot Business seats for the organization.", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "The total number of seats being billed for the organization as of the current billing cycle." - }, - "added_this_cycle": { - "type": "integer", - "description": "Seats added during the current billing cycle." - }, - "pending_cancellation": { - "type": "integer", - "description": "The number of seats that are pending cancellation at the end of the current billing cycle." - }, - "pending_invitation": { - "type": "integer", - "description": "The number of users who have been invited to receive a Copilot seat through this organization." - }, - "active_this_cycle": { - "type": "integer", - "description": "The number of seats that have used Copilot during the current billing cycle." - }, - "inactive_this_cycle": { - "type": "integer", - "description": "The number of seats that have not used Copilot during the current billing cycle." - } - } - }, - "public_code_suggestions": { - "type": "string", - "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", - "enum": [ - "allow", - "block", - "unconfigured" - ] - }, - "ide_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "platform_chat": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "cli": { - "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] - }, - "seat_management_setting": { - "type": "string", - "description": "The mode of assigning new seats.", - "enum": [ - "assign_all", - "assign_selected", - "disabled", - "unconfigured" - ] - }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise" - ] - } - }, - "required": [ - "seat_breakdown", - "public_code_suggestions", - "seat_management_setting" - ], - "additionalProperties": true - }, - "examples": { - "default": { - "value": { - "seat_breakdown": { - "total": 12, - "added_this_cycle": 9, - "pending_invitation": 0, - "pending_cancellation": 0, - "active_this_cycle": 12, - "inactive_this_cycle": 11 - }, - "seat_management_setting": "assign_selected", - "ide_chat": "enabled", - "platform_chat": "enabled", - "cli": "enabled", - "public_code_suggestions": "block", - "plan_type": "business" - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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" - } + ] } } } @@ -80205,39 +78461,36 @@ } } } - }, - "422": { - "description": "There is a problem with your account's associated payment method." } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/copilot/billing/seats": { + "/orgs/{org}/codespaces": { "get": { - "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "summary": "List codespaces for the organization", + "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/list-copilot-seats", + "operationId": "codespaces/list-in-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "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": "string" + "type": "integer", + "default": 30 } }, { @@ -80250,12 +78503,12 @@ } }, { - "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", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 50 + "type": "string" } } ], @@ -80266,19 +78519,44 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "codespaces" + ], "properties": { - "total_seats": { - "type": "integer", - "description": "Total number of Copilot seats for the organization currently being billed." + "total_count": { + "type": "integer" }, - "seats": { + "codespaces": { "type": "array", "items": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", + "title": "Codespace", + "description": "A codespace.", "properties": { - "assignee": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "example": "monalisa-octocat-hello-world-g4wpq6h95q" + }, + "display_name": { + "description": "Display name for this codespace.", + "type": "string", + "example": "bookish space pancake", + "nullable": true + }, + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": "string", + "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "nullable": true + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -80400,371 +78678,1083 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, "login": { "type": "string", - "example": "github" + "example": "octocat" }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/orgs/github" + "example": "https://api.github.com/users/octocat" }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/orgs/github/repos" + "example": "https://github.com/octocat" }, - "events_url": { + "followers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/orgs/github/events" + "example": "https://api.github.com/users/octocat/followers" }, - "hooks_url": { + "following_url": { "type": "string", - "example": "https://api.github.com/orgs/github/hooks" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "issues_url": { + "gists_url": { "type": "string", - "example": "https://api.github.com/orgs/github/issues" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "members_url": { + "starred_url": { "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "public_members_url": { + "subscriptions_url": { "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "avatar_url": { + "organizations_url": { "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "description": { + "repos_url": { "type": "string", - "example": "A great organization", - "nullable": true + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ - "login", - "url", + "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", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ], - "nullable": true + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, "name": { + "nullable": true, "type": "string" }, - "slug": { + "email": { + "nullable": true, "type": "string" }, - "description": { + "login": { "type": "string", - "nullable": true + "example": "octocat" }, - "privacy": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "notification_setting": { - "type": "string" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "permission": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" + "example": "https://github.com/octocat" }, - "repositories_url": { + "followers_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" + "admin": { + "type": "boolean" }, - "description": { - "type": "string" + "maintain": { + "type": "boolean" }, - "slug": { - "type": "string" + "push": { + "type": "boolean" }, - "url": { - "type": "string", - "format": "uri" + "triage": { + "type": "boolean" }, - "sync_to_organizations": { + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "example": "disabled | all" + "example": "contributor_covenant" }, - "organization_selection_type": { + "name": { "type": "string", - "example": "disabled | all" + "example": "Contributor Covenant" }, - "group_id": { - "nullable": true, + "url": { "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, - "group_name": { - "nullable": true, + "body": { "type": "string", - "example": "Justice League" + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/enterprises/dc/teams/justice-league" - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + "nullable": true } }, "required": [ - "id", "url", - "members_url", - "name", "html_url", - "slug", - "created_at", - "updated_at" + "key", + "name" ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "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" + ] + }, + "machine": { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "example": "standardLinux" + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "example": "4 cores, 16 GB RAM, 64 GB storage" + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "example": "linux" + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "example": 68719476736 + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "example": 17179869184 + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "example": 4 + }, + "prebuild_availability": { + "type": "string", + "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", + "example": "ready", + "enum": [ + "none", + "ready", + "in_progress" + ], + "nullable": true } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" ], "nullable": true }, - "pending_cancellation_date": { + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", "type": "string", - "format": "date", - "nullable": true, - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + "example": ".devcontainer/example/devcontainer.json", + "nullable": true }, - "last_activity_at": { + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": "boolean", + "example": false, + "nullable": true + }, + "created_at": { "type": "string", "format": "date-time", - "nullable": true, - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + "example": "2011-01-26T19:01:12Z" }, - "last_activity_editor": { + "updated_at": { "type": "string", - "nullable": true, - "description": "Last editor that was used by the user for a GitHub Copilot completion." + "format": "date-time", + "example": "2011-01-26T19:01:12Z" }, - "created_at": { + "last_used_at": { + "description": "Last known time this codespace was started.", "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + "example": "2011-01-26T19:01:12Z" }, - "updated_at": { + "state": { + "description": "State of this codespace.", + "enum": [ + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "example": "Available", + "type": "string" + }, + "url": { + "description": "API URL for this codespace.", + "type": "string", + "format": "uri" + }, + "git_status": { + "description": "Details about the codespace's git repository.", + "type": "object", + "properties": { + "ahead": { + "description": "The number of commits the local repository is ahead of the remote.", + "type": "integer", + "example": 0 + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "example": 0 + }, + "has_unpushed_changes": { + "description": "Whether the local repository has unpushed changes.", + "type": "boolean" + }, + "has_uncommitted_changes": { + "description": "Whether the local repository has uncommitted changes.", + "type": "boolean" + }, + "ref": { + "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", + "type": "string", + "example": "main" + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "example": "WestUs2", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": "integer", + "example": 60, + "nullable": true + }, + "web_url": { + "description": "URL to access this codespace on the web.", + "type": "string", + "format": "uri" + }, + "machines_url": { + "description": "API URL to access available alternate machine types for this codespace.", + "type": "string", + "format": "uri" + }, + "start_url": { + "description": "API URL to start this codespace.", + "type": "string", + "format": "uri" + }, + "stop_url": { + "description": "API URL to stop this codespace.", + "type": "string", + "format": "uri" + }, + "publish_url": { + "description": "API URL to publish this codespace to a new repository.", + "type": "string", + "format": "uri", + "nullable": true + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": "string", + "format": "uri", + "nullable": true + }, + "recent_folders": { + "type": "array", + "items": { + "type": "string" + } + }, + "runtime_constraints": { + "type": "object", + "properties": { + "allowed_port_privacy_settings": { + "description": "The privacy settings a user can select from when forwarding a port.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + }, + "pending_operation": { + "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", + "type": "boolean", + "nullable": true + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": "string", + "nullable": true + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": "string", + "nullable": true + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer", + "example": 60, + "nullable": true + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", "type": "string", "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "example": "2011-01-26T20:01:12Z", + "nullable": true }, - "plan_type": { + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" - ] + "example": "you've used 100% of your spending limit for Codespaces", + "nullable": true } }, "required": [ - "created_at" - ], - "additionalProperties": false + "id", + "name", + "environment_id", + "owner", + "billable_owner", + "repository", + "machine", + "prebuild", + "created_at", + "updated_at", + "last_used_at", + "state", + "url", + "git_status", + "location", + "idle_timeout_minutes", + "web_url", + "machines_url", + "start_url", + "stop_url", + "pulls_url", + "recent_folders" + ] } } } @@ -80772,16 +79762,13 @@ "examples": { "default": { "value": { - "total_seats": 2, - "seats": [ + "total_count": 3, + "codespaces": [ { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "plan_type": "business", - "assignee": { + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -80801,64 +79788,421 @@ "type": "User", "site_admin": false }, - "assigning_team": { + "billable_owner": { + "login": "octocat", "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } + "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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] }, { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "assignee": { - "login": "octokitten", + "id": 1, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "owner": { + "login": "octocat", "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", + "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 - } + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/foobar/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "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": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-f8adfad99a", + "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", + "recent_folders": [] } ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } }, + "304": { + "description": "Not modified" + }, "500": { "description": "Internal Error", "content": { @@ -80966,23 +80310,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" } } }, - "/orgs/{org}/copilot/billing/selected_teams": { - "post": { - "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "/orgs/{org}/codespaces/access": { + "put": { + "summary": "Manage access control for organization codespaces", + "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/add-copilot-seats-for-teams", + "operationId": "codespaces/set-codespaces-access", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces" }, "parameters": [ { @@ -80995,95 +80339,63 @@ } } ], + "deprecated": true, "requestBody": { + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "selected_teams": { + "visibility": { + "type": "string", + "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.", + "enum": [ + "disabled", + "selected_members", + "all_members", + "all_members_and_outside_collaborators" + ] + }, + "selected_usernames": { "type": "array", - "description": "List of team names within the organization to which to grant access to GitHub Copilot.", + "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.", "items": { "type": "string" }, - "minItems": 1 + "maxItems": 100 } }, "required": [ - "selected_teams" + "visibility" ] }, "examples": { "default": { "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" + "visibility": "selected_members", + "selected_usernames": [ + "johnDoe", + "atomIO" ] } } } } - }, - "required": true + } }, "responses": { - "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for members of the specified team(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } + "204": { + "description": "Response when successfully modifying permissions." }, - "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" - } - } - } - } - } + "304": { + "description": "Not modified" }, - "401": { - "description": "Requires authentication", + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81108,14 +80420,18 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -81123,19 +80439,58 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -81159,28 +80514,27 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" } - }, - "delete": { - "summary": "Remove teams from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + } + }, + "/orgs/{org}/codespaces/access/selected_users": { + "post": { + "summary": "Add users to Codespaces access for an organization", + "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", + "operationId": "codespaces/set-codespaces-access-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" }, "parameters": [ { @@ -81193,95 +80547,52 @@ } } ], + "deprecated": true, "requestBody": { + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "selected_teams": { + "selected_usernames": { "type": "array", - "description": "The names of teams from which to revoke access to GitHub Copilot.", + "description": "The usernames of the organization members whose codespaces be billed to the organization.", "items": { "type": "string" }, - "minItems": 1 + "maxItems": 100 } }, "required": [ - "selected_teams" + "selected_usernames" ] }, "examples": { "default": { "value": { - "selected_teams": [ - "engteam1", - "engteam2", - "engteam3" + "selected_usernames": [ + "johnDoe", + "atomIO" ] } } } } - }, - "required": true + } }, "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", - "properties": { - "seats_cancelled": { - "type": "integer" - } - }, - "required": [ - "seats_cancelled" - ] - }, - "examples": { - "default": { - "value": { - "seats_cancelled": 5 - } - } - } - } - } + "204": { + "description": "Response when successfully modifying permissions." }, - "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" - } - } - } - } - } + "304": { + "description": "Not modified" }, - "401": { - "description": "Requires authentication", + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81306,14 +80617,18 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -81321,19 +80636,58 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -81357,31 +80711,27 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" } - } - }, - "/orgs/{org}/copilot/billing/selected_users": { - "post": { - "summary": "Add users to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + }, + "delete": { + "summary": "Remove users from Codespaces access for an organization", + "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/add-copilot-seats-for-users", + "operationId": "codespaces/delete-codespaces-access-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" }, + "deprecated": true, "parameters": [ { "name": "org", @@ -81394,6 +80744,7 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { @@ -81401,11 +80752,11 @@ "properties": { "selected_usernames": { "type": "array", - "description": "The usernames of the organization members to be granted access to GitHub Copilot.", + "description": "The usernames of the organization members whose codespaces should not be billed to the organization.", "items": { "type": "string" }, - "minItems": 1 + "maxItems": 100 } }, "required": [ @@ -81416,72 +80767,27 @@ "default": { "value": { "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" + "johnDoe", + "atomIO" ] } } } } - }, - "required": true + } }, "responses": { - "201": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The total number of seats created for the specified user(s).", - "properties": { - "seats_created": { - "type": "integer" - } - }, - "required": [ - "seats_created" - ] - }, - "examples": { - "default": { - "value": { - "seats_created": 5 - } - } - } - } - } + "204": { + "description": "Response when successfully modifying permissions." }, - "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" - } - } - } - } - } + "304": { + "description": "Not modified" }, - "401": { - "description": "Requires authentication", + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -81506,14 +80812,18 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -81521,19 +80831,58 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -81557,28 +80906,27 @@ } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" } - }, - "delete": { - "summary": "Remove users from the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + } + }, + "/orgs/{org}/codespaces/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/cancel-copilot-seat-assignment-for-users", + "operationId": "codespaces/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets" }, "parameters": [ { @@ -81589,196 +80937,334 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", - "items": { - "type": "string" - }, - "minItems": 1 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "cooluser1", - "hacker2", - "octocat" - ] - } - } - } + }, + { + "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 } }, - "required": true - }, + { + "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": "OK", + "description": "Response", "content": { "application/json": { "schema": { "type": "object", - "description": "The total number of seats set to \"pending cancellation\" for the specified users.", + "required": [ + "total_count", + "secrets" + ], "properties": { - "seats_cancelled": { + "total_count": { "type": "integer" - } - }, - "required": [ - "seats_cancelled" - ] + }, + "secrets": { + "type": "array", + "items": { + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret", + "example": "SECRET_NAME", + "type": "string" + }, + "created_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "The type of repositories in the organization that the secret is visible to", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } + } + } }, "examples": { "default": { "value": { - "seats_cancelled": 5 + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z", + "visibility": "all" + } + ] } } } } - } - }, - "500": { - "description": "Internal Error", - "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" } } } - }, - "401": { - "description": "Requires authentication", + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key" + }, + "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", + "title": "CodespacesPublicKey", + "description": "The public key used for setting Codespaces secrets.", "type": "object", "properties": { - "message": { - "type": "string" + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" }, - "documentation_url": { - "type": "string" + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 }, "url": { - "type": "string" + "type": "string", + "example": "https://api.github.com/user/keys/2" }, - "status": { - "type": "string" + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the secret", + "example": "SECRET_NAME", "type": "string" }, - "documentation_url": { - "type": "string" + "created_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" }, - "url": { - "type": "string" + "updated_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" }, - "status": { + "visibility": { + "description": "The type of repositories in the organization that the secret is visible to", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" } } } } - } - }, - "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" } } } - }, - "422": { - "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } - } - }, - "/orgs/{org}/copilot/metrics": { - "get": { - "summary": "Get Copilot metrics for an organization", - "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/copilot-metrics-for-organization", + "operationId": "codespaces/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -81791,538 +81277,93 @@ } }, { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "query", - "required": false, + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, "schema": { "type": "string" } - }, - { - "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 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). 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": 28 - } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "type": "object", - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": "string", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in the IDE.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": "string", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": "object", - "description": "Usage metrics for Copilot Chat in GitHub.com", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": "string", - "description": "The training date for the custom model (if applicable).", - "nullable": true - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": "object", - "description": "Usage metrics for Copilot for pull requests.", - "nullable": true, - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": "string", - "nullable": true, - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "The ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } } }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 ] } } } } - }, - "500": { - "description": "Internal Error", + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null } } } } }, - "403": { - "description": "Forbidden", + "204": { + "description": "Response when updating a secret" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82347,14 +81388,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -82362,19 +81407,101 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "422": { - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -82402,23 +81529,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/dependabot/alerts": { + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { "get": { - "summary": "List Dependabot alerts for an organization", - "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "codespaces" ], - "operationId": "dependabot/list-alerts-for-org", + "operationId": "codespaces/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -82431,145 +81558,21 @@ } }, { - "name": "state", - "in": "query", - "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", - "schema": { - "type": "string" - } - }, - { - "name": "severity", - "in": "query", - "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", - "schema": { - "type": "string" - } - }, - { - "name": "ecosystem", - "in": "query", - "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", - "schema": { - "type": "string" - } - }, - { - "name": "package", - "in": "query", - "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "epss_percentage", - "in": "query", - "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", - "schema": { - "type": "string" - } - }, - { - "name": "has", - "in": "query", - "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.", - "schema": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string", - "enum": [ - "patch" - ] - } - } - ] - } - }, - { - "name": "scope", - "in": "query", - "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", - "schema": { - "type": "string", - "enum": [ - "development", - "runtime" - ] - } - }, - { - "name": "sort", - "in": "query", - "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "epss_percentage" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "first", - "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", + "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", - "required": false, "schema": { "type": "integer", - "minimum": 1, - "maximum": 100 + "default": 1 } }, { @@ -82588,688 +81591,38 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A Dependabot alert.", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "state": { - "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, - "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" - ] - }, - "dependency": { - "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "manifest_path": { - "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true - }, - "scope": { - "type": "string", - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "nullable": true, - "enum": [ - "development", - "runtime" - ] - }, - "relationship": { - "type": "string", - "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", - "readOnly": true, - "nullable": true, - "enum": [ - "unknown", - "direct", - "transitive" - ] - } - } - }, - "security_advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true - }, - "cve_id": { - "type": "string", - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true, - "nullable": true - }, - "summary": { - "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 - }, - "description": { - "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true - }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": "object", - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "nullable": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - } - }, - "severity": { - "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": "string", - "description": "The full CVSS vector string for the advisory.", - "readOnly": true, - "nullable": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cvss_severities": { - "type": "object", - "nullable": true, - "properties": { - "cvss_v3": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 3 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 3 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cvss_v4": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS 4 vector string.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS 4 score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - } - } - }, - "epss": { - "type": "object", - "nullable": true, - "readOnly": true, - "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", - "properties": { - "percentage": { - "type": "number", - "minimum": 0, - "maximum": 100 - }, - "percentile": { - "type": "number", - "minimum": 0, - "maximum": 100 - } - } - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { - "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "withdrawn_at": { - "type": "string", - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "security_vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "severity": { - "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { - "type": "object", - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "nullable": true, - "properties": { - "identifier": { - "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true - } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "dismissed_at": { - "type": "string", - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "dismissed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "dismissed_reason": { - "type": "string", - "description": "The reason that the alert was dismissed.", - "nullable": true, - "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk" - ] - }, - "dismissed_comment": { - "type": "string", - "description": "An optional comment associated with the alert's dismissal.", - "nullable": true, - "maxLength": 280 - }, - "fixed_at": { - "type": "string", - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "auto_dismissed_at": { - "type": "string", - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." + "example": 1296269 }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", - "example": "Hello-World", - "description": "The name of the repository." + "example": "Hello-World" }, "full_name": { "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." + "example": "octocat/Hello-World" }, "owner": { "title": "Simple User", @@ -83396,1722 +81749,190 @@ ] }, "private": { - "type": "boolean", - "description": "Whether the repository is private." + "type": "boolean" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." + "example": "https://github.com/octocat/Hello-World" }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true, - "description": "The repository description." + "nullable": true }, "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." + "type": "boolean" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." + "example": "https://api.github.com/repos/octocat/Hello-World" }, "archive_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, "assignees_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, "blobs_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, "branches_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, "collaborators_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, "commits_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, "compare_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, "contents_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, "git_commits_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, "git_refs_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, "git_tags_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" }, "issue_comment_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, "issue_events_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, "issues_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, "keys_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, "labels_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, "merges_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, "milestones_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, "notifications_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, "releases_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, "statuses_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, "subscription_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, "teams_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, "trees_url": { "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "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": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at", - "repository" - ], - "additionalProperties": false - } - }, - "examples": { - "default": { - "value": [ - { - "number": 2, - "state": "dismissed", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-rf4j-j272-fj86", - "cve_id": "CVE-2018-6188", - "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", - "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 1.11.8, < 1.11.10", - "first_patched_version": { - "identifier": "1.11.10" - } - } - ], - "severity": "high", - "cvss": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", - "score": 7.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", - "score": 8.7 - } - }, - "epss": [ - { - "percentage": 0.00045, - "percentile": "0.16001e0" - } - ], - "cwes": [ - { - "cwe_id": "CWE-200", - "name": "Exposure of Sensitive Information to an Unauthorized Actor" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-rf4j-j272-fj86" - }, - { - "type": "CVE", - "value": "CVE-2018-6188" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" - }, - { - "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" - }, - { - "url": "https://usn.ubuntu.com/3559-1/" - }, - { - "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" - }, - { - "url": "http://www.securitytracker.com/id/1040422" - } - ], - "published_at": "2018-10-03T21:13:54Z", - "updated_at": "2022-04-26T18:35:37Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "django" - }, - "severity": "high", - "vulnerable_version_range": ">= 2.0.0, < 2.0.2", - "first_patched_version": { - "identifier": "2.0.2" - } - }, - "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", - "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", - "created_at": "2022-06-15T07:43:03Z", - "updated_at": "2022-08-23T14:29:47Z", - "dismissed_at": "2022-08-23T14:29:47Z", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_reason": "tolerable_risk", - "dismissed_comment": "This alert is accurate but we use a sanitizer.", - "fixed_at": null, - "repository": { - "id": 217723378, - "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", - "name": "octo-repo", - "full_name": "octo-org/octo-repo", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "private": true, - "html_url": "https://github.com/octo-org/octo-repo", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/octo-repo", - "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", - "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", - "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", - "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", - "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", - "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", - "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", - "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" - } - }, - { - "number": 1, - "state": "open", - "dependency": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "manifest_path": "path/to/requirements.txt", - "scope": "runtime" - }, - "security_advisory": { - "ghsa_id": "GHSA-8f4m-hccc-8qph", - "cve_id": "CVE-2021-20191", - "summary": "Insertion of Sensitive Information into Log File in ansible", - "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", - "vulnerabilities": [ - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.9.0, < 2.9.18", - "first_patched_version": { - "identifier": "2.9.18" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": ">= 2.10.0, < 2.10.7", - "first_patched_version": { - "identifier": "2.10.7" - } - } - ], - "severity": "medium", - "cvss": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_severities": { - "cvss_v3": { - "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", - "score": 5.5 - }, - "cvss_v4": { - "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", - "score": 8.5 - } - }, - "cwes": [ - { - "cwe_id": "CWE-532", - "name": "Insertion of Sensitive Information into Log File" - } - ], - "identifiers": [ - { - "type": "GHSA", - "value": "GHSA-8f4m-hccc-8qph" - }, - { - "type": "CVE", - "value": "CVE-2021-20191" - } - ], - "references": [ - { - "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" - }, - { - "url": "https://access.redhat.com/security/cve/cve-2021-20191" - }, - { - "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" - } - ], - "published_at": "2021-06-01T17:38:00Z", - "updated_at": "2021-08-12T23:06:00Z", - "withdrawn_at": null - }, - "security_vulnerability": { - "package": { - "ecosystem": "pip", - "name": "ansible" - }, - "severity": "medium", - "vulnerable_version_range": "< 2.8.19", - "first_patched_version": { - "identifier": "2.8.19" - } - }, - "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", - "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", - "created_at": "2022-06-14T15:21:52Z", - "updated_at": "2022-06-14T15:21:52Z", - "dismissed_at": null, - "dismissed_by": null, - "dismissed_reason": null, - "dismissed_comment": null, - "fixed_at": null, - "repository": { - "id": 664700648, - "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", - "name": "hello-world", - "full_name": "octo-org/hello-world", - "owner": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "private": true, - "html_url": "https://github.com/octo-org/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octo-org/hello-world", - "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", - "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", - "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", - "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", - "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", - "events_url": "https://api.github.com/repos/octo-org/hello-world/events", - "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", - "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", - "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", - "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", - "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", - "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", - "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", - "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", - "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", - "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", - "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", - "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", - "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" - } - } - ] - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Bad Request", - "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "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" - } - } - } - } - } - }, - "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 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" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "alerts" - } - } - }, - "/orgs/{org}/dependabot/secrets": { - "get": { - "summary": "List organization secrets", - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/list-org-secrets", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" - }, - "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/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": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 3, - "secrets": [ - { - "name": "MY_ARTIFACTORY_PASSWORD", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "NPM_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GH_TOKEN", - "created_at": "2021-08-10T14:59:22Z", - "updated_at": "2021-12-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/public-key": { - "get": { - "summary": "Get an organization public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" - }, - "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": "DependabotPublicKey", - "description": "The public key used for setting Dependabot Secrets.", - "type": "object", - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "example": "1234567" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - } - }, - "required": [ - "key_id", - "key" - ] - }, - "examples": { - "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/get-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Dependabot Secret for an Organization", - "description": "Secrets for GitHub Dependabot for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "NPM_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - }, - "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/create-or-update-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "ID of the key you used to encrypt the secret." - }, - "visibility": { - "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "string" - } - } - }, - "required": [ - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - "1296269", - "1296280" - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a secret", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { - "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "dependabot" - ], - "operationId": "dependabot/list-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true }, "hooks_url": { "type": "string", @@ -85544,25 +82365,51 @@ } } } + }, + "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": "secrets" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "codespaces" ], - "operationId": "dependabot/set-selected-repos-for-org-secret", + "operationId": "codespaces/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -85593,7 +82440,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -85618,27 +82465,56 @@ "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" + } + } + } + } + } + }, + "409": { + "description": "Conflict when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "codespaces" ], - "operationId": "dependabot/add-selected-repo-to-org-secret", + "operationId": "codespaces/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -85672,27 +82548,122 @@ "204": { "description": "No Content when repository was added to the selected list" }, + "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 when visibility type is not set to selected" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "dependabot" + "codespaces" ], - "operationId": "dependabot/remove-selected-repo-from-org-secret", + "operationId": "codespaces/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -85726,29 +82697,124 @@ "204": { "description": "Response when repository was removed from the selected list" }, + "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 when visibility type not set to selected" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "secrets" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/docker/conflicts": { + "/orgs/{org}/copilot/billing": { "get": { - "summary": "Get list of conflicting packages during Docker migration for organization", - "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "summary": "Get Copilot seat information and settings for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ - "packages" + "copilot" ], - "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "operationId": "copilot/get-copilot-organization-details", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" }, "parameters": [ { @@ -85763,207 +82829,307 @@ ], "responses": { "200": { - "description": "Response", + "description": "OK", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Package", - "description": "A software package", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the package.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the package.", - "type": "string", - "example": "super-linter" - }, - "package_type": { - "type": "string", - "example": "docker", - "enum": [ - "npm", - "maven", - "rubygems", - "docker", - "nuget", - "container" - ] - }, - "url": { - "type": "string", - "example": "https://api.github.com/orgs/github/packages/container/super-linter" - }, - "html_url": { - "type": "string", - "example": "https://github.com/orgs/github/packages/container/package/super-linter" - }, - "version_count": { - "description": "The number of versions of the package.", - "type": "integer", - "example": 1 - }, - "visibility": { - "type": "string", - "example": "private", - "enum": [ - "private", - "public" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", + "type": "object", + "properties": { + "seat_breakdown": { + "title": "Copilot Seat Breakdown", + "description": "The breakdown of Copilot Business seats for the organization.", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of seats being billed for the organization as of the current billing cycle." }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "added_this_cycle": { + "type": "integer", + "description": "Seats added during the current billing cycle." + }, + "pending_cancellation": { + "type": "integer", + "description": "The number of seats that are pending cancellation at the end of the current billing cycle." + }, + "pending_invitation": { + "type": "integer", + "description": "The number of users who have been invited to receive a Copilot seat through this organization." + }, + "active_this_cycle": { + "type": "integer", + "description": "The number of seats that have used Copilot during the current billing cycle." + }, + "inactive_this_cycle": { + "type": "integer", + "description": "The number of seats that have not used Copilot during the current billing cycle." + } + } + }, + "public_code_suggestions": { + "type": "string", + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" + ] + }, + "ide_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "platform_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "cli": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "seat_management_setting": { + "type": "string", + "description": "The mode of assigning new seats.", + "enum": [ + "assign_all", + "assign_selected", + "disabled", + "unconfigured" + ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise" + ] + } + }, + "required": [ + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true + }, + "examples": { + "default": { + "value": { + "seat_breakdown": { + "total": 12, + "added_this_cycle": 9, + "pending_invitation": 0, + "pending_cancellation": 0, + "active_this_cycle": 12, + "inactive_this_cycle": 11 }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { + "seat_management_setting": "assign_selected", + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "There is a problem with your account's associated payment method." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/seats": { + "get": { + "summary": "List all Copilot seat assignments for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/list-copilot-seats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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": 50 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_seats": { + "type": "integer", + "description": "Total number of Copilot seats for the organization currently being billed." + }, + "seats": { + "type": "array", + "items": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "type": "object", + "properties": { + "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -86085,3680 +83251,2025 @@ "subscriptions_url", "type", "url" - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", + ], "nullable": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { - "key": { + "login": { "type": "string", - "example": "contributor_covenant" + "example": "github" }, - "name": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { "type": "string", - "example": "Contributor Covenant" + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + "example": "https://api.github.com/orgs/github" }, - "html_url": { + "repos_url": { "type": "string", "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "name", - "package_type", - "visibility", - "url", - "html_url", - "version_count", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 197, - "name": "hello_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - }, - "version_count": 1, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/hello_docker", - "created_at": "2020-05-19T22:19:11Z", - "updated_at": "2020-05-19T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" - }, - { - "id": 198, - "name": "goodbye_docker", - "package_type": "container", - "owner": { - "login": "github", - "id": 9919, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - }, - "version_count": 2, - "visibility": "private", - "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", - "created_at": "2020-05-20T22:19:11Z", - "updated_at": "2020-05-20T22:19:11Z", - "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" - } - ] - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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": false, - "category": "packages", - "subcategory": "packages" - } - } - }, - "/orgs/{org}/events": { - "get": { - "summary": "List public organization events", - "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", - "tags": [ - "activity" - ], - "operationId": "activity/list-public-org-events", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" - }, - "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/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": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string", - "nullable": true - }, - "actor": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "name", - "url" - ] - }, - "org": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" + "example": "https://api.github.com/orgs/github/repos" }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", + "events_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "repository_url": { + "hooks_url": { "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" + "example": "https://api.github.com/orgs/github/hooks" }, - "comments_url": { + "issues_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/orgs/github/issues" }, - "events_url": { + "members_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/orgs/github/members{/member}" }, - "html_url": { + "public_members_url": { "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", + "avatar_url": { "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] - }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" + "example": "https://github.com/images/error/octocat_happy.gif" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "description": { "type": "string", + "example": "A great organization", "nullable": true - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ], + "nullable": true + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { - "type": "integer", - "format": "int64", - "example": 1 + "type": "integer" }, "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "type": "string" }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { "name": { - "nullable": true, "type": "string" }, - "email": { - "nullable": true, + "slug": { "type": "string" }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" + "privacy": { + "type": "string" }, - "site_admin": { - "type": "boolean" + "notification_setting": { + "type": "string" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "permission": { + "type": "string" }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } }, - "user_view_type": { - "type": "string", - "example": "public" - } + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "format": "uri" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" + "example": "https://github.com/orgs/rails/teams/core" }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", + "members_url": { "type": "string" }, - "description": { + "repositories_url": { "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true + "format": "uri" }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", - "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/organizations/1/team/1" }, - "followers_url": { + "members_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "following_url": { + "name": { + "description": "Name of the team", "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "Justice League" }, - "gists_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "nullable": true, + "example": "A great team." }, - "starred_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "admin" }, - "subscriptions_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "closed" }, - "organizations_url": { + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "notifications_enabled" }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "https://github.com/orgs/rails/teams/core" }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "starred_at": { + "slug": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "justice-league" }, - "user_view_type": { - "type": "string", - "example": "public" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } }, "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" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ], "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true } }, "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", "id", "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", + "members_url", + "name", + "description", + "permission", "html_url", - "patch_url", - "url" + "repositories_url", + "slug", + "parent" ] }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" + "name": { + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "description": { + "type": "string" }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "slug": { + "type": "string" }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri" }, - "subscriptions_url": { + "sync_to_organizations": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "disabled | all" }, - "organizations_url": { + "organization_selection_type": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "disabled | all" }, - "repos_url": { + "group_id": { + "nullable": true, "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "62ab9291-fae2-468e-974b-7e45096d5021" }, - "events_url": { + "group_name": { + "nullable": true, "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "Justice League" }, - "received_events_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true + "example": "https://github.com/enterprises/dc/teams/justice-league" }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true + "members_url": { + "type": "string" }, "created_at": { "type": "string", - "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", - "description": "The time the issue type last updated.", "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." } }, "required": [ "id", - "node_id", + "url", + "members_url", "name", - "description" + "html_url", + "slug", + "created_at", + "updated_at" ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", + } + ], + "nullable": true + }, + "pending_cancellation_date": { + "type": "string", + "format": "date", + "nullable": true, + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": "string", + "nullable": true, + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] + } + }, + "required": [ + "created_at" + ], + "additionalProperties": false + } + } + } + }, + "examples": { + "default": { + "value": { + "total_seats": 2, + "seats": [ + { + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "plan_type": "business", + "assignee": { + "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 + }, + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/selected_teams": { + "post": { + "summary": "Add teams to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-copilot-seats-for-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_teams": { + "type": "array", + "description": "List of team names within the organization to which to grant access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_teams" + ] + }, + "examples": { + "default": { + "value": { + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats created for members of the specified team(s).", + "properties": { + "seats_created": { + "type": "integer" + } + }, + "required": [ + "seats_created" + ] + }, + "examples": { + "default": { + "value": { + "seats_created": 5 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + }, + "delete": { + "summary": "Remove teams from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_teams": { + "type": "array", + "description": "The names of teams from which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_teams" + ] + }, + "examples": { + "default": { + "value": { + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", + "properties": { + "seats_cancelled": { + "type": "integer" + } + }, + "required": [ + "seats_cancelled" + ] + }, + "examples": { + "default": { + "value": { + "seats_cancelled": 5 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/selected_users": { + "post": { + "summary": "Add users to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-copilot-seats-for-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members to be granted access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats created for the specified user(s).", + "properties": { + "seats_created": { + "type": "integer" + } + }, + "required": [ + "seats_created" + ] + }, + "examples": { + "default": { + "value": { + "seats_created": 5 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + }, + "delete": { + "summary": "Remove users from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/cancel-copilot-seat-assignment-for-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", + "properties": { + "seats_cancelled": { + "type": "integer" + } + }, + "required": [ + "seats_cancelled" + ] + }, + "examples": { + "default": { + "value": { + "seats_cancelled": 5 + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": "object", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { "type": "object", "properties": { - "key": { - "type": "string", - "example": "mit" - }, "name": { "type": "string", - "example": "MIT License" + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." }, - "spdx_id": { + "custom_model_training_date": { "type": "string", "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" + "description": "The training date for the custom model." }, - "push": { - "type": "boolean" + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." }, - "maintain": { - "type": "boolean" + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { "type": "object", "properties": { "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." }, - "organizations_url": { + "custom_model_training_date": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "nullable": true, + "description": "The training date for the custom model." }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." }, - "type": { + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in GitHub.com", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": "object", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { "type": "string", - "example": "User" + "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." }, - "site_admin": { - "type": "boolean" + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." }, - "starred_at": { + "custom_model_training_date": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "nullable": true, + "description": "The training date for the custom model." }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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" + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." }, - "lexical_commit_sha": { - "type": "string" + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." } } } - }, - "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" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at" - ] - }, - "comment": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] - }, - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": "string" - }, - "title": { - "type": "string" - }, - "summary": { - "type": "string", - "nullable": true - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" } } } } } - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time", - "nullable": true } }, "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] + "date" + ], + "additionalProperties": true } }, "examples": { - "200-response": { + "default": { "value": [ { - "id": "22237752260", - "type": "WatchEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" - }, - "repo": { - "id": 1296269, - "name": "octo-org/octo-repo", - "url": "https://api.github.com/repos/octo-org/octo-repo" - }, - "payload": { - "action": "started" - }, - "public": true, - "created_at": "2022-06-08T23:29:25Z" - }, - { - "id": "22249084964", - "type": "PushEvent", - "actor": { - "id": 583231, - "login": "octocat", - "display_login": "octocat", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] }, - "repo": { - "id": 1296269, - "name": "octo-org/octo-repo", - "url": "https://api.github.com/repos/octo-org/oct-repo" + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] }, - "payload": { - "push_id": 10115855396, - "size": 1, - "distinct_size": 1, - "ref": "refs/heads/master", - "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "before": "883efe034920928c47fe18598c01249d1a9fdabd", - "commits": [ + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ { - "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", - "author": { - "email": "octocat@github.com", - "name": "Monalisa Octocat" - }, - "message": "commit", - "distinct": true, - "url": "https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 } ] }, - "public": true, - "created_at": "2022-06-09T12:47:28Z" + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } } ] } } } } + }, + "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" + } + } + } + } + } + }, + "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": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "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": "activity", - "subcategory": "events" + "category": "copilot", + "subcategory": "copilot-metrics" } } }, - "/orgs/{org}/failed_invitations": { + "/orgs/{org}/dependabot/alerts": { "get": { - "summary": "List failed organization invitations", - "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", + "summary": "List Dependabot alerts for an organization", + "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/list-failed-invitations", + "operationId": "dependabot/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations" + "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" }, "parameters": [ { @@ -89771,21 +85282,154 @@ } }, { - "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).\"", + "name": "state", + "in": "query", + "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", + "schema": { + "type": "string" + } + }, + { + "name": "severity", + "in": "query", + "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", + "schema": { + "type": "string" + } + }, + { + "name": "package", + "in": "query", + "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "has", + "in": "query", + "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "patch" + ] + } + } + ] + } + }, + { + "name": "scope", + "in": "query", + "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", + "schema": { + "type": "string", + "enum": [ + "development", + "runtime" + ] + } + }, + { + "name": "sort", + "in": "query", + "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "epss_percentage" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "first", + "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.", "in": "query", + "required": false, "schema": { "type": "integer", + "minimum": 1, + "maximum": 100, "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).\"", + "name": "last", + "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.", "in": "query", + "required": false, "schema": { "type": "integer", - "default": 1 + "minimum": 1, + "maximum": 100 + } + }, + { + "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 } } ], @@ -89797,37 +85441,505 @@ "schema": { "type": "array", "items": { - "title": "Organization Invitation", - "description": "Organization Invitation", "type": "object", + "description": "A Dependabot alert.", "properties": { - "id": { + "number": { "type": "integer", - "format": "int64" + "description": "The security alert number.", + "readOnly": true }, - "login": { + "state": { "type": "string", - "nullable": true + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "auto_dismissed", + "dismissed", + "fixed", + "open" + ] }, - "email": { + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": "string", + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "nullable": true, + "enum": [ + "development", + "runtime" + ] + }, + "relationship": { + "type": "string", + "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", + "readOnly": true, + "nullable": true, + "enum": [ + "unknown", + "direct", + "transitive" + ] + } + } + }, + "security_advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true, + "nullable": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": "object", + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "nullable": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": "string", + "description": "The full CVSS vector string for the advisory.", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cvss_severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "epss": { + "type": "object", + "nullable": true, + "readOnly": true, + "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", + "properties": { + "percentage": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "percentile": { + "type": "number", + "minimum": 0, + "maximum": 100 + } + } + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": "string", + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false + }, + "security_vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": "object", + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "nullable": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "url": { "type": "string", - "nullable": true + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "role": { - "type": "string" + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "failed_at": { + "updated_at": { "type": "string", - "nullable": true + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "failed_reason": { + "dismissed_at": { "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, "nullable": true }, - "inviter": { + "dismissed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -89949,83 +86061,965 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, - "team_count": { - "type": "integer" + "dismissed_reason": { + "type": "string", + "description": "The reason that the alert was dismissed.", + "nullable": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk" + ] }, - "node_id": { + "dismissed_comment": { "type": "string", - "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "description": "An optional comment associated with the alert's dismissal.", + "nullable": true, + "maxLength": 280 }, - "invitation_teams_url": { + "fixed_at": { "type": "string", - "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "invitation_source": { + "auto_dismissed_at": { "type": "string", - "example": "\"member\"" - } - }, - "required": [ - "id", - "login", - "email", - "role", + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "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": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", + "html_url", "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" - ] + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at", + "repository" + ], + "additionalProperties": false } }, "examples": { "default": { "value": [ { - "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "failed_at": "", - "failed_reason": "", - "inviter": { - "login": "other_user", + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, + "epss": [ + { + "percentage": 0.00045, + "percentile": "0.16001e0" + } + ], + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", + "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", + "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 }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" + } + }, + { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "repository": { + "id": 664700648, + "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", + "name": "hello-world", + "full_name": "octo-org/hello-world", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/hello-world", + "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", + "events_url": "https://api.github.com/repos/octo-org/hello-world/events", + "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", + "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", + "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", + "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", + "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", + "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" + } } ] } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "304": { + "description": "Not modified" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } } } } @@ -90055,27 +87049,57 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "members" + "category": "dependabot", + "subcategory": "alerts" } } }, - "/orgs/{org}/hooks": { + "/orgs/{org}/dependabot/secrets": { "get": { - "summary": "List organization webhooks", - "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/list-webhooks", + "operationId": "dependabot/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks" + "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" }, "parameters": [ { @@ -90112,121 +87136,86 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" - }, - "name": { - "type": "string", - "example": "web" - }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "example": true - }, - "config": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" }, - "insecure_ssl": { + "created_at": { "type": "string", - "example": "\"0\"" + "format": "date-time" }, - "content_type": { + "updated_at": { "type": "string", - "example": "\"form\"" + "format": "date-time" }, - "secret": { + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { "type": "string", - "example": "\"********\"" + "format": "uri", + "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" - }, - "type": { - "type": "string" + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] + } } }, "examples": { "default": { - "value": [ - { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" + "value": { + "total_count": 3, + "secrets": [ + { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "private" }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - ] + { + "name": "NPM_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" + } + ] + } } } } @@ -90239,51 +87228,27 @@ } } } - }, - "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": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } - }, - "post": { - "summary": "Create an organization webhook", - "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + } + }, + "/orgs/{org}/dependabot/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/create-webhook", + "operationId": "dependabot/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -90296,320 +87261,37 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Must be passed as \"web\"." - }, - "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } - ] - }, - "username": { - "type": "string", - "example": "\"kdaigle\"" - }, - "password": { - "type": "string", - "example": "\"password\"" - } - }, - "required": [ - "url" - ] - }, - "events": { - "type": "array", - "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", - "default": [ - "push" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "default": true - } - }, - "required": [ - "name", - "config" - ] - }, - "examples": { - "default": { - "value": { - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "url": "http://example.com/webhook", - "content_type": "json" - } - } - } - } - } - } - }, "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Org Hook", - "description": "Org Hook", + "title": "DependabotPublicKey", + "description": "The public key used for setting Dependabot Secrets.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" - }, - "name": { - "type": "string", - "example": "web" - }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "example": true - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" - }, - "insecure_ssl": { - "type": "string", - "example": "\"0\"" - }, - "content_type": { - "type": "string", - "example": "\"form\"" - }, - "secret": { - "type": "string", - "example": "\"********\"" - } - } - }, - "updated_at": { + "key_id": { + "description": "The identifier for the key.", "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" + "example": "1234567" }, - "created_at": { + "key": { + "description": "The Base64 encoded public key.", "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" - }, - "type": { - "type": "string" + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" } }, "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" + "key_id", + "key" ] }, "examples": { "default": { "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/orgs/octocat/hooks/1", - "schema": { - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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" + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } @@ -90620,22 +87302,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/hooks/{hook_id}": { + "/orgs/{org}/dependabot/secrets/{secret_name}": { "get": { - "summary": "Get an organization webhook", - "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/get-webhook", + "operationId": "dependabot/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" }, "parameters": [ { @@ -90648,12 +87330,12 @@ } }, { - "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.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -90663,141 +87345,53 @@ "content": { "application/json": { "schema": { - "title": "Org Hook", - "description": "Org Hook", + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" }, - "deliveries_url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + "format": "date-time" }, - "name": { + "updated_at": { "type": "string", - "example": "web" + "format": "date-time" }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "example": true - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" - }, - "insecure_ssl": { - "type": "string", - "example": "\"0\"" - }, - "content_type": { - "type": "string", - "example": "\"form\"" - }, - "secret": { - "type": "string", - "example": "\"********\"" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" + "type": "string" }, - "created_at": { + "selected_repositories_url": { "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" - }, - "type": { - "type": "string" + "format": "uri", + "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" } }, "required": [ - "id", - "url", - "type", "name", - "active", - "events", - "config", - "ping_url", "created_at", - "updated_at" + "updated_at", + "visibility" ] }, "examples": { "default": { "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - } - }, - "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": "NPM_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" } } } @@ -90808,20 +87402,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } }, - "patch": { - "summary": "Update an organization webhook", - "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/update-webhook", + "operationId": "dependabot/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -90834,86 +87428,61 @@ } }, { - "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.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } - ] - } - }, - "required": [ - "url" + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" ] }, - "events": { + "selected_repository_ids": { "type": "array", - "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", - "default": [ - "push" - ], + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "string" } - }, - "active": { - "type": "boolean", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "default": true - }, - "name": { - "type": "string", - "example": "\"web\"" } - } + }, + "required": [ + "visibility" + ] }, "examples": { "default": { "value": { - "active": true, - "events": [ - "pull_request" + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + "1296269", + "1296280" ] } } @@ -90922,238 +87491,46 @@ } }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "Response when creating a secret", "content": { "application/json": { "schema": { - "title": "Org Hook", - "description": "Org Hook", + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" - }, - "deliveries_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" - }, - "name": { - "type": "string", - "example": "web" - }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "example": true - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" - }, - "insecure_ssl": { - "type": "string", - "example": "\"0\"" - }, - "content_type": { - "type": "string", - "example": "\"form\"" - }, - "secret": { - "type": "string", - "example": "\"********\"" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] + "properties": {}, + "additionalProperties": false }, "examples": { "default": { - "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", - "name": "web", - "events": [ - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - } - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } + "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" - } - } - } - } - } + "204": { + "description": "Response when updating a secret" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } }, "delete": { - "summary": "Delete an organization webhook", - "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/delete-webhook", + "operationId": "dependabot/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -91166,157 +87543,39 @@ } }, { - "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.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "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" - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/hooks/{hook_id}/config": { + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { "get": { - "summary": "Get a webhook configuration for an organization", - "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/get-webhook-config-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Webhook Configuration", - "description": "Configuration object of the webhook", - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" - } - }, - "patch": { - "summary": "Update a webhook configuration for an organization", - "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", - "tags": [ - "orgs" - ], - "operationId": "orgs/update-webhook-config-for-org", + "operationId": "dependabot/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -91329,144 +87588,8 @@ } }, { - "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.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "summary": "Update an existing webhook", - "value": { - "url": "http://example.com/webhook", - "content_type": "json", - "insecure_ssl": "0", - "secret": "********" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Webhook Configuration", - "description": "Configuration object of the webhook", - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } - ] - } - } - }, - "examples": { - "default": { - "value": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" - } - } - }, - "/orgs/{org}/hooks/{hook_id}/deliveries": { - "get": { - "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-webhook-deliveries", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -91474,12 +87597,12 @@ } }, { - "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.", - "in": "path", - "required": true, + "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" + "type": "integer", + "default": 1 } }, { @@ -91490,15 +87613,6 @@ "type": "integer", "default": 30 } - }, - { - "name": "cursor", - "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { @@ -91507,259 +87621,777 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple webhook delivery", - "description": "Delivery made by a webhook, without request and response information.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the webhook delivery.", - "type": "integer", - "format": "int64", - "example": 42 - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" - }, - "delivered_at": { - "description": "Time when the webhook delivery occurred.", - "type": "string", - "format": "date-time", - "example": "2021-05-12T20:33:44Z" - }, - "redelivery": { - "description": "Whether the webhook delivery is a redelivery.", - "type": "boolean", - "example": false - }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "example": 0.03 - }, - "status": { - "description": "Describes the response returned after attempting the delivery.", - "type": "string", - "example": "failed to connect" - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "example": 502 - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "example": "issues" - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": "string", - "example": "opened", - "nullable": true - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": "integer", - "format": "int64", - "example": 123, - "nullable": true - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": "integer", - "format": "int64", - "example": 123, - "nullable": true - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": "string", - "format": "date-time", - "example": "2021-05-12T20:33:44Z", - "nullable": true - } - }, - "required": [ - "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 12345678, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-03T00:57:16Z", - "redelivery": false, - "duration": 0.27, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "throttled_at": "2019-06-03T00:57:16Z" - }, - { - "id": 123456789, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-04T00:57:16Z", - "redelivery": true, - "duration": 0.28, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "throttled_at": null - } - ] - } - } - } - } - }, - "400": { - "description": "Bad Request", - "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "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" + "total_count", + "repositories" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "repositories": { "type": "array", "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "field": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "message": { + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "code": { + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { "type": "string" }, - "index": { + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { "type": "integer" }, - "value": { - "oneOf": [ - { + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "nullable": true + "example": "contributor_covenant" }, - { - "type": "integer", + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } } } - ] + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } + }, + "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" + ] } } } + }, + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } } } } @@ -91768,22 +88400,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } - } - }, - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { - "get": { - "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/get-webhook-delivery", + "operationId": "dependabot/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -91796,363 +88426,70 @@ } }, { - "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.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "delivery_id", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Webhook delivery", - "description": "Delivery made by a webhook.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the delivery.", - "type": "integer", - "example": 42 - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" - }, - "delivered_at": { - "description": "Time when the delivery was delivered.", - "type": "string", - "format": "date-time", - "example": "2021-05-12T20:33:44Z" - }, - "redelivery": { - "description": "Whether the delivery is a redelivery.", - "type": "boolean", - "example": false - }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "example": 0.03 - }, - "status": { - "description": "Description of the status of the attempted delivery", - "type": "string", - "example": "failed to connect" - }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "example": 502 - }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "example": "issues" - }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": "string", - "example": "opened", - "nullable": true - }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": "integer", - "example": 123, - "nullable": true - }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": "integer", - "example": 123, - "nullable": true - }, - "throttled_at": { - "description": "Time when the webhook delivery was throttled.", - "type": "string", - "format": "date-time", - "example": "2021-05-12T20:33:44Z", - "nullable": true - }, - "url": { - "description": "The URL target of the delivery.", - "type": "string", - "example": "https://www.example.com" - }, - "request": { - "type": "object", - "properties": { - "headers": { - "description": "The request headers sent with the webhook delivery.", - "type": "object", - "nullable": true, - "additionalProperties": true - }, - "payload": { - "description": "The webhook payload.", - "type": "object", - "nullable": true, - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - }, - "response": { - "type": "object", - "properties": { - "headers": { - "description": "The response headers received when the delivery was made.", - "type": "object", - "nullable": true, - "additionalProperties": true - }, - "payload": { - "description": "The response payload received.", - "type": "string", - "nullable": true, - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] - } - }, - "required": [ - "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id", - "request", - "response" - ] - }, - "examples": { - "default": { - "value": { - "id": 12345678, - "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "delivered_at": "2019-06-03T00:57:16Z", - "redelivery": false, - "duration": 0.27, - "status": "OK", - "status_code": 200, - "event": "issues", - "action": "opened", - "installation_id": 123, - "repository_id": 456, - "url": "https://www.example.com", - "throttled_at": "2019-06-03T00:57:16Z", - "request": { - "headers": { - "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "Accept": "*/*", - "X-GitHub-Hook-ID": "42", - "User-Agent": "GitHub-Hookshot/b8c71d8", - "X-GitHub-Event": "issues", - "X-GitHub-Hook-Installation-Target-ID": "123", - "X-GitHub-Hook-Installation-Target-Type": "repository", - "content-type": "application/json", - "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" - }, - "payload": { - "action": "opened", - "issue": { - "body": "foo" - }, - "repository": { - "id": 123 - } - } - }, - "response": { - "headers": { - "Content-Type": "text/html;charset=utf-8" - }, - "payload": "ok" - } - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] } } } } } }, + "responses": { + "204": { + "description": "Response" + } + }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { - "post": { - "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/redeliver-webhook-delivery", + "operationId": "dependabot/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -92165,16 +88502,16 @@ } }, { - "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.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "delivery_id", + "name": "repository_id", "in": "path", "required": true, "schema": { @@ -92183,170 +88520,30 @@ } ], "responses": { - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "400": { - "description": "Bad Request", - "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } + "204": { + "description": "No Content when repository was added to the selected list" }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } + "409": { + "description": "Conflict when visibility type is not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } - } - }, - "/orgs/{org}/hooks/{hook_id}/pings": { - "post": { - "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "dependabot" ], - "operationId": "orgs/ping-webhook", + "operationId": "dependabot/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook" + "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -92359,8 +88556,16 @@ } }, { - "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.", + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", "in": "path", "required": true, "schema": { @@ -92370,54 +88575,31 @@ ], "responses": { "204": { - "description": "Response" + "description": "Response when repository was removed from the selected list" }, - "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 when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "webhooks" + "category": "dependabot", + "subcategory": "secrets" } } }, - "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + "/orgs/{org}/docker/conflicts": { "get": { - "summary": "Get route stats by actor", - "description": "Get API request count statistics for an actor broken down by route within a specified time frame.", + "summary": "Get list of conflicting packages during Docker migration for organization", + "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", "tags": [ - "orgs" + "packages" ], - "operationId": "api-insights/get-route-stats-by-actor", + "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor" + "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" }, "parameters": [ { @@ -92428,111 +88610,6 @@ "schema": { "type": "string" } - }, - { - "name": "actor_type", - "in": "path", - "description": "The type of the actor", - "required": true, - "schema": { - "type": "string", - "enum": [ - "installation", - "classic_pat", - "fine_grained_pat", - "oauth_app", - "github_app_user_to_server" - ] - } - }, - { - "name": "actor_id", - "in": "path", - "description": "The ID of the actor", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "last_rate_limited_timestamp", - "last_request_timestamp", - "rate_limited_request_count", - "http_method", - "api_route", - "total_request_count" - ], - "default": "total_request_count" - } - } - }, - { - "name": "api_route_substring", - "in": "query", - "description": "Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { @@ -92541,926 +88618,1026 @@ "content": { "application/json": { "schema": { - "title": "Route Stats", - "description": "API Insights usage route stats for an actor", "type": "array", "items": { + "title": "Package", + "description": "A software package", "type": "object", "properties": { - "http_method": { - "description": "The HTTP method", - "type": "string" + "id": { + "description": "Unique identifier of the package.", + "type": "integer", + "example": 1 }, - "api_route": { - "description": "The API path's route template", - "type": "string" + "name": { + "description": "The name of the package.", + "type": "string", + "example": "super-linter" }, - "total_request_count": { - "description": "The total number of requests within the queried time period", - "type": "integer", - "format": "int64" + "package_type": { + "type": "string", + "example": "docker", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] }, - "rate_limited_request_count": { - "description": "The total number of requests that were rate limited within the queried time period", + "url": { + "type": "string", + "example": "https://api.github.com/orgs/github/packages/container/super-linter" + }, + "html_url": { + "type": "string", + "example": "https://github.com/orgs/github/packages/container/package/super-linter" + }, + "version_count": { + "description": "The number of versions of the package.", "type": "integer", - "format": "int64" + "example": 1 }, - "last_rate_limited_timestamp": { + "visibility": { "type": "string", - "nullable": true + "example": "private", + "enum": [ + "private", + "public" + ] }, - "last_request_timestamp": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "http_method": "GET", - "api_route": "/repositories/:repository_id", - "total_request_count": 544665, - "rate_limited_request_count": 13, - "last_request_timestamp": "2024-09-18T15:43:03Z", - "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" - } - ] - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/subject-stats": { - "get": { - "summary": "Get subject stats", - "description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-subject-stats", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-subject-stats" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "last_rate_limited_timestamp", - "last_request_timestamp", - "rate_limited_request_count", - "subject_name", - "total_request_count" - ], - "default": "total_request_count" - } - } - }, - { - "name": "subject_name_substring", - "in": "query", - "description": "Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Subject Stats", - "description": "API Insights usage subject stats for an organization", - "type": "array", - "items": { - "type": "object", - "properties": { - "subject_type": { - "type": "string" - }, - "subject_name": { - "type": "string" - }, - "subject_id": { - "type": "integer", - "format": "int64" - }, - "total_request_count": { - "type": "integer" + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "rate_limited_request_count": { - "type": "integer" + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "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" + ], + "nullable": true }, - "last_rate_limited_timestamp": { + "created_at": { "type": "string", - "nullable": true + "format": "date-time" }, - "last_request_timestamp": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time" } - } + }, + "required": [ + "id", + "name", + "package_type", + "visibility", + "url", + "html_url", + "version_count", + "created_at", + "updated_at" + ] } }, "examples": { "default": { "value": [ { - "subject_type": "installation", - "subject_id": 954453, - "subject_name": "GitHub Actions", - "integration_id": 124345, - "total_request_count": 544665, - "rate_limited_request_count": 13, - "last_request_timestamp": "2024-09-18T15:43:03Z", - "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + "id": 197, + "name": "hello_docker", + "package_type": "container", + "owner": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "version_count": 1, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker", + "created_at": "2020-05-19T22:19:11Z", + "updated_at": "2020-05-19T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" + }, + { + "id": 198, + "name": "goodbye_docker", + "package_type": "container", + "owner": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "version_count": 2, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", + "created_at": "2020-05-20T22:19:11Z", + "updated_at": "2020-05-20T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" } ] } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/summary-stats": { - "get": { - "summary": "Get summary stats", - "description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-summary-stats", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Summary Stats", - "description": "API Insights usage summary stats for an organization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_request_count": { - "description": "The total number of requests within the queried time period", - "type": "integer", - "format": "int64" + "message": { + "type": "string" }, - "rate_limited_request_count": { - "description": "The total number of requests that were rate limited within the queried time period", - "type": "integer", - "format": "int64" - } - } - }, - "examples": { - "default": { - "value": { - "total_request_count": 34225, - "rate_limited_request_count": 23 - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { - "get": { - "summary": "Get summary stats by user", - "description": "Get overall statistics of API requests within the organization for a user.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-summary-stats-by-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "user_id", - "in": "path", - "description": "The ID of the user to query for stats", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Summary Stats", - "description": "API Insights usage summary stats for an organization", - "type": "object", - "properties": { - "total_request_count": { - "description": "The total number of requests within the queried time period", - "type": "integer", - "format": "int64" + "documentation_url": { + "type": "string" }, - "rate_limited_request_count": { - "description": "The total number of requests that were rate limited within the queried time period", - "type": "integer", - "format": "int64" - } - } - }, - "examples": { - "default": { - "value": { - "total_request_count": 34225, - "rate_limited_request_count": 23 + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { - "get": { - "summary": "Get summary stats by actor", - "description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-summary-stats-by-actor", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "actor_type", - "in": "path", - "description": "The type of the actor", - "required": true, - "schema": { - "type": "string", - "enum": [ - "installation", - "classic_pat", - "fine_grained_pat", - "oauth_app", - "github_app_user_to_server" - ] - } }, - { - "name": "actor_id", - "in": "path", - "description": "The ID of the actor", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { - "title": "Summary Stats", - "description": "API Insights usage summary stats for an organization", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_request_count": { - "description": "The total number of requests within the queried time period", - "type": "integer", - "format": "int64" + "message": { + "type": "string" }, - "rate_limited_request_count": { - "description": "The total number of requests that were rate limited within the queried time period", - "type": "integer", - "format": "int64" - } - } - }, - "examples": { - "default": { - "value": { - "total_request_count": 34225, - "rate_limited_request_count": 23 - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/time-stats": { - "get": { - "summary": "Get time stats", - "description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-time-stats", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "timestamp_increment", - "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Time Stats", - "description": "API Insights usage time stats for an organization", - "type": "array", - "items": { - "type": "object", - "properties": { - "timestamp": { - "type": "string" - }, - "total_request_count": { - "type": "integer", - "format": "int64" - }, - "rate_limited_request_count": { - "type": "integer", - "format": "int64" - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "timestamp": "2024-09-11T15:00:00Z", - "total_request_count": 34225, - "rate_limited_request_count": 0 - }, - { - "timestamp": "2024-09-11T15:05:00Z", - "total_request_count": 10587, - "rate_limited_request_count": 18 - }, - { - "timestamp": "2024-09-11T15:10:00Z", - "total_request_count": 43587, - "rate_limited_request_count": 14 - }, - { - "timestamp": "2024-09-11T15:15:00Z", - "total_request_count": 19463, - "rate_limited_request_count": 4 - }, - { - "timestamp": "2024-09-11T15:20:00Z", - "total_request_count": 60542, - "rate_limited_request_count": 3 - }, - { - "timestamp": "2024-09-11T15:25:00Z", - "total_request_count": 55872, - "rate_limited_request_count": 23 - } - ] - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/time-stats/users/{user_id}": { - "get": { - "summary": "Get time stats by user", - "description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-time-stats-by-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "user_id", - "in": "path", - "description": "The ID of the user to query for stats", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "timestamp_increment", - "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Time Stats", - "description": "API Insights usage time stats for an organization", - "type": "array", - "items": { - "type": "object", - "properties": { - "timestamp": { - "type": "string" - }, - "total_request_count": { - "type": "integer", - "format": "int64" - }, - "rate_limited_request_count": { - "type": "integer", - "format": "int64" - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "timestamp": "2024-09-11T15:00:00Z", - "total_request_count": 34225, - "rate_limited_request_count": 0 - }, - { - "timestamp": "2024-09-11T15:05:00Z", - "total_request_count": 10587, - "rate_limited_request_count": 18 - }, - { - "timestamp": "2024-09-11T15:10:00Z", - "total_request_count": 43587, - "rate_limited_request_count": 14 - }, - { - "timestamp": "2024-09-11T15:15:00Z", - "total_request_count": 19463, - "rate_limited_request_count": 4 - }, - { - "timestamp": "2024-09-11T15:20:00Z", - "total_request_count": 60542, - "rate_limited_request_count": 3 - }, - { - "timestamp": "2024-09-11T15:25:00Z", - "total_request_count": 55872, - "rate_limited_request_count": 23 - } - ] - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { - "get": { - "summary": "Get time stats by actor", - "description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.", - "tags": [ - "orgs" - ], - "operationId": "api-insights/get-time-stats-by-actor", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "actor_type", - "in": "path", - "description": "The type of the actor", - "required": true, - "schema": { - "type": "string", - "enum": [ - "installation", - "classic_pat", - "fine_grained_pat", - "oauth_app", - "github_app_user_to_server" - ] - } - }, - { - "name": "actor_id", - "in": "path", - "description": "The ID of the actor", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "timestamp_increment", - "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Time Stats", - "description": "API Insights usage time stats for an organization", - "type": "array", - "items": { - "type": "object", - "properties": { - "timestamp": { - "type": "string" - }, - "total_request_count": { - "type": "integer", - "format": "int64" - }, - "rate_limited_request_count": { - "type": "integer", - "format": "int64" - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": [ - { - "timestamp": "2024-09-11T15:00:00Z", - "total_request_count": 34225, - "rate_limited_request_count": 0 - }, - { - "timestamp": "2024-09-11T15:05:00Z", - "total_request_count": 10587, - "rate_limited_request_count": 18 - }, - { - "timestamp": "2024-09-11T15:10:00Z", - "total_request_count": 43587, - "rate_limited_request_count": 14 - }, - { - "timestamp": "2024-09-11T15:15:00Z", - "total_request_count": 19463, - "rate_limited_request_count": 4 - }, - { - "timestamp": "2024-09-11T15:20:00Z", - "total_request_count": 60542, - "rate_limited_request_count": 3 - }, - { - "timestamp": "2024-09-11T15:25:00Z", - "total_request_count": 55872, - "rate_limited_request_count": 23 - } - ] - } } } } } }, "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" } } }, - "/orgs/{org}/insights/api/user-stats/{user_id}": { + "/orgs/{org}/events": { "get": { - "summary": "Get user stats", - "description": "Get API usage statistics within an organization for a user broken down by the type of access.", + "summary": "List public organization events", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ - "orgs" + "activity" ], - "operationId": "api-insights/get-user-stats", + "operationId": "activity/list-public-org-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/api-insights#get-user-stats" + "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" }, "parameters": [ { @@ -93472,42 +89649,6 @@ "type": "string" } }, - { - "name": "user_id", - "in": "path", - "description": "The ID of the user to query for stats", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "min_timestamp", - "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "max_timestamp", - "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, { "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).\"", @@ -93518,46 +89659,12 @@ } }, { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "last_rate_limited_timestamp", - "last_request_timestamp", - "rate_limited_request_count", - "subject_name", - "total_request_count" - ], - "default": "total_request_count" - } - } - }, - { - "name": "actor_name_substring", + "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", - "description": "Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.", - "required": false, "schema": { - "type": "string" + "type": "integer", + "default": 1 } } ], @@ -93567,1076 +89674,186 @@ "content": { "application/json": { "schema": { - "title": "User Stats", - "description": "API Insights usage stats for a user", "type": "array", "items": { + "title": "Event", + "description": "Event", "type": "object", "properties": { - "actor_type": { - "type": "string" - }, - "actor_name": { + "id": { "type": "string" }, - "actor_id": { - "type": "integer", - "format": "int64" - }, - "integration_id": { - "type": "integer", - "format": "int64", - "nullable": true - }, - "oauth_application_id": { - "type": "integer", - "format": "int64", - "nullable": true - }, - "total_request_count": { - "type": "integer" - }, - "rate_limited_request_count": { - "type": "integer" - }, - "last_rate_limited_timestamp": { + "type": { "type": "string", "nullable": true }, - "last_request_timestamp": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": [ - { - "actor_type": "oauth_app", - "actor_id": 954453, - "actor_name": "GitHub Actions", - "oauth_application_id": 1245, - "total_request_count": 544665, - "rate_limited_request_count": 13, - "last_request_timestamp": "2024-09-18T15:43:03Z", - "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" - } - ] - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "api-insights" - } - } - }, - "/orgs/{org}/installation": { - "get": { - "summary": "Get an organization installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/get-org-installation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" - }, - "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": "Installation", - "description": "Installation", - "type": "object", - "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "account": { - "nullable": true, - "anyOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "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" - ] + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/app/installations/1/access_tokens" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/installation/repositories" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/organizations/github/settings/installations/1" - }, - "app_id": { - "type": "integer", - "example": 1 - }, - "client_id": { - "type": "string", - "example": "Iv1.ab1112223334445c" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "example": "Organization" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_org_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for custom property management.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" - ] - }, - "organization_announcement_banners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_events": { - "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] - }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] - }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "has_multiple_single_files": { - "type": "boolean", - "example": true - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" + "required": [ + "id", + "name", + "url" + ] }, - "example": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "example": "github-actions" - }, - "suspended_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "org": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "contact_email": { - "type": "string", - "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", - "nullable": true - } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "account": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/orgs/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - }, - "repository_selection": "all", - "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/github/settings/installations/1", - "app_id": 1, - "client_id": "Iv1.ab1112223334445c", - "target_id": 1, - "target_type": "Organization", - "permissions": { - "checks": "write", - "metadata": "read", - "contents": "read" + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] }, - "events": [ - "push", - "pull_request" - ], - "created_at": "2018-02-09T20:51:14Z", - "updated_at": "2018-02-09T20:51:14Z", - "single_file_name": "config.yml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "apps", - "subcategory": "apps" - } - } - }, - "/orgs/{org}/installations": { - "get": { - "summary": "List app installations for an organization", - "description": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\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:read` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-app-installations", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/orgs#list-app-installations-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/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": { - "type": "object", - "required": [ - "total_count", - "installations" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "installations": { - "type": "array", - "items": { - "title": "Installation", - "description": "Installation", + "payload": { "type": "object", "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 + "action": { + "type": "string" }, - "account": { - "nullable": true, - "anyOf": [ - { + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -94758,1057 +89975,2640 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/enterprises/octo-business" + "example": "https://github.com/octocat" }, - "website_url": { - "description": "The enterprise's website URL.", + "followers_url": { "type": "string", - "nullable": true, - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" + "type": "integer", + "example": 1002604 }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, - "name": { - "description": "The name of the enterprise.", + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", "type": "string", - "example": "Octo Business" + "enum": [ + "open", + "closed" + ], + "default": "open" }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { "type": "string", - "example": "octo-business" + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 }, "created_at": { "type": "string", - "nullable": true, "format": "date-time", - "example": "2019-01-26T19:01:12Z" + "example": "2011-04-10T20:09:31Z" }, "updated_at": { "type": "string", - "nullable": true, "format": "date-time", - "example": "2019-01-26T19:14:43Z" + "example": "2014-03-03T18:58:10Z" }, - "avatar_url": { + "closed_at": { "type": "string", - "format": "uri" + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true } }, "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", "id", "node_id", - "name", - "slug", + "labels_url", "html_url", + "number", + "open_issues", + "state", + "title", + "url", "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/app/installations/1/access_tokens" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/installation/repositories" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/organizations/github/settings/installations/1" - }, - "app_id": { - "type": "integer", - "example": 1 - }, - "client_id": { - "type": "string", - "example": "Iv1.ab1112223334445c" - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "example": "Organization" - }, - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "dependabot_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot secrets.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] + "updated_at" + ], + "nullable": true }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] + "locked": { + "type": "boolean" }, - "organization_custom_org_roles": { + "active_lock_reason": { "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] + "nullable": true }, - "organization_custom_properties": { - "type": "string", - "description": "The level of permission to grant the access token for custom property management.", - "enum": [ - "read", - "write", - "admin" - ] + "comments": { + "type": "integer" }, - "organization_copilot_seat_management": { - "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", - "enum": [ - "write" + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" ] }, - "organization_announcement_banners": { + "closed_at": { "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] + "format": "date-time", + "nullable": true }, - "organization_events": { + "created_at": { "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] + "format": "date-time" }, - "organization_hooks": { + "updated_at": { "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "organization_personal_access_tokens": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] + "draft": { + "type": "boolean" }, - "organization_personal_access_token_requests": { - "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] + "body_html": { + "type": "string" }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", - "enum": [ - "read", - "write", - "admin" - ] + "body_text": { + "type": "string" }, - "organization_packages": { + "timeline_url": { "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "format": "uri" }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" ] }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] - }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" ] }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" ] }, - "gpg_keys": { + "author_association": { + "title": "author_association", "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "example": "OWNER", + "description": "How the author is associated with the repository.", "enum": [ - "read", - "write" + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" ] }, - "interaction_limits": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] }, - "profile": { - "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" ] }, - "starring": { - "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] } }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "has_multiple_single_files": { - "type": "boolean", - "example": true - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "config.yml", - ".github/issue_TEMPLATE.md" + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" ] }, - "app_slug": { - "type": "string", - "example": "github-actions" - }, - "suspended_by": { - "title": "Simple User", - "description": "A GitHub user.", + "comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the issue comment", + "example": 42, "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "type": "string" }, "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "format": "uri" }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "body_text": { + "type": "string" }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "body_html": { + "type": "string" }, - "subscriptions_url": { + "html_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "repos_url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "events_url": { + "updated_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "received_events_url": { + "issue_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri" }, - "type": { + "author_association": { + "title": "author_association", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] }, - "user_view_type": { - "type": "string", - "example": "public" + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] }, - "contact_email": { - "type": "string", - "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", - "nullable": true + "pages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "page_name": { + "type": "string" + }, + "title": { + "type": "string" + }, + "summary": { + "type": "string", + "nullable": true + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + } } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" - ] + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true } - } + }, + "required": [ + "id", + "type", + "actor", + "repo", + "payload", + "public", + "created_at" + ] } }, "examples": { - "default": { - "value": { - "total_count": 1, - "installations": [ - { - "id": 25381, - "account": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", - "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", - "site_admin": false - }, - "repository_selection": "selected", - "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/octo-org/settings/installations/25381", - "app_id": 2218, - "target_id": 6811672, - "target_type": "Organization", - "permissions": { - "deployments": "write", - "metadata": "read", - "pull_requests": "read", - "statuses": "read" - }, - "events": [ - "deployment", - "deployment_status" - ], - "created_at": "2017-05-16T08:47:09.000-07:00", - "updated_at": "2017-06-06T11:23:23.000-07:00", - "single_file_name": "config.yml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "app_slug": "github-actions", - "suspended_at": null, - "suspended_by": null - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" - } - } - }, - "/orgs/{org}/interaction-limits": { - "get": { - "summary": "Get interaction restrictions for an organization", - "description": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.", - "tags": [ - "interactions" - ], - "operationId": "interactions/get-restrictions-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-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": { - "anyOf": [ - { - "title": "Interaction Limits", - "description": "Interaction limit settings.", - "type": "object", - "properties": { - "limit": { - "type": "string", - "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", - "example": "collaborators_only", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ] + "200-response": { + "value": [ + { + "id": "22237752260", + "type": "WatchEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, - "origin": { - "type": "string", - "example": "repository" + "repo": { + "id": 1296269, + "name": "octo-org/octo-repo", + "url": "https://api.github.com/repos/octo-org/octo-repo" }, - "expires_at": { - "type": "string", - "format": "date-time", - "example": "2018-08-17T04:18:39Z" - } + "payload": { + "action": "started" + }, + "public": true, + "created_at": "2022-06-08T23:29:25Z" }, - "required": [ - "limit", - "origin", - "expires_at" - ] - }, - { - "type": "object", - "properties": {}, - "additionalProperties": false - } - ] - }, - "examples": { - "default": { - "value": { - "limit": "collaborators_only", - "origin": "organization", - "expires_at": "2018-08-17T04:18:39Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "orgs" - } - }, - "put": { - "summary": "Set interaction restrictions for an organization", - "description": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.", - "tags": [ - "interactions" - ], - "operationId": "interactions/set-restrictions-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-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": { - "title": "Interaction Restrictions", - "description": "Limit interactions to a specific type of user for a specified duration", - "type": "object", - "properties": { - "limit": { - "type": "string", - "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", - "example": "collaborators_only", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ] - }, - "expiry": { - "type": "string", - "description": "The duration of the interaction restriction. Default: `one_day`.", - "example": "one_month", - "enum": [ - "one_day", - "three_days", - "one_week", - "one_month", - "six_months" - ] - } - }, - "required": [ - "limit" - ] - }, - "examples": { - "default": { - "value": { - "limit": "collaborators_only", - "expiry": "one_month" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Interaction Limits", - "description": "Interaction limit settings.", - "type": "object", - "properties": { - "limit": { - "type": "string", - "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", - "example": "collaborators_only", - "enum": [ - "existing_users", - "contributors_only", - "collaborators_only" - ] - }, - "origin": { - "type": "string", - "example": "repository" - }, - "expires_at": { - "type": "string", - "format": "date-time", - "example": "2018-08-17T04:18:39Z" - } - }, - "required": [ - "limit", - "origin", - "expires_at" - ] - }, - "examples": { - "default": { - "value": { - "limit": "collaborators_only", - "origin": "organization", - "expires_at": "2018-08-17T04:18:39Z" - } - } - } - } - } - }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octo-org/octo-repo", + "url": "https://api.github.com/repos/octo-org/oct-repo" + }, + "payload": { + "push_id": 10115855396, + "size": 1, + "distinct_size": 1, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd", + "commits": [ + { + "sha": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "author": { + "email": "octocat@github.com", + "name": "Monalisa Octocat" }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + "message": "commit", + "distinct": true, + "url": "https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300" + } + ] + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z" } - } + ] } } } @@ -95818,56 +92618,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "orgs" - } - }, - "delete": { - "summary": "Remove interaction restrictions for an organization", - "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", - "tags": [ - "interactions" - ], - "operationId": "interactions/remove-restrictions-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-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" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "interactions", - "subcategory": "orgs" + "category": "activity", + "subcategory": "events" } } }, - "/orgs/{org}/invitations": { + "/orgs/{org}/failed_invitations": { "get": { - "summary": "List pending organization invitations", - "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub\nmember, the `login` field in the return hash will be `null`.", + "summary": "List failed organization invitations", + "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", "tags": [ "orgs" ], - "operationId": "orgs/list-pending-invitations", + "operationId": "orgs/list-failed-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-pending-organization-invitations" + "url": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations" }, "parameters": [ { @@ -95896,38 +92662,6 @@ "type": "integer", "default": 1 } - }, - { - "name": "role", - "description": "Filter invitations by their member role.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "admin", - "direct_member", - "billing_manager", - "hiring_manager" - ], - "default": "all" - } - }, - { - "name": "invitation_source", - "description": "Filter invitations by their invitation source.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "member", - "scim" - ], - "default": "all" - } } ], "responses": { @@ -96204,17 +92938,227 @@ "category": "orgs", "subcategory": "members" } + } + }, + "/orgs/{org}/hooks": { + "get": { + "summary": "List organization webhooks", + "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-webhooks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks" + }, + "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/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": { + "type": "array", + "items": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + }, + "name": { + "type": "string", + "example": "web" + }, + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { + "type": "string", + "example": "\"0\"" + }, + "content_type": { + "type": "string", + "example": "\"form\"" + }, + "secret": { + "type": "string", + "example": "\"********\"" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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": "orgs", + "subcategory": "webhooks" + } }, "post": { - "summary": "Create an organization invitation", - "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "summary": "Create an organization webhook", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/create-invitation", + "operationId": "orgs/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#create-an-organization-invitation" + "url": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook" }, "parameters": [ { @@ -96228,49 +93172,95 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "invitee_id": { - "type": "integer", - "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting." - }, - "email": { + "name": { "type": "string", - "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user." + "description": "Must be passed as \"web\"." }, - "role": { - "type": "string", - "description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.", - "enum": [ - "admin", - "direct_member", - "billing_manager", - "reinstate" - ], - "default": "direct_member" + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook.", + "properties": { + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] + }, + "username": { + "type": "string", + "example": "\"kdaigle\"" + }, + "password": { + "type": "string", + "example": "\"password\"" + } + }, + "required": [ + "url" + ] }, - "team_ids": { + "events": { "type": "array", - "description": "Specify IDs for the teams you want to invite new members to.", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", + "default": [ + "push" + ], "items": { - "type": "integer" + "type": "string" } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true } - } + }, + "required": [ + "name", + "config" + ] }, "examples": { "default": { "value": { - "email": "octocat@github.com", - "role": "direct_member", - "team_ids": [ - 12, - 26 - ] + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "url": "http://example.com/webhook", + "content_type": "json" + } } } } @@ -96283,224 +93273,127 @@ "content": { "application/json": { "schema": { - "title": "Organization Invitation", - "description": "Organization Invitation", + "title": "Org Hook", + "description": "Org Hook", "type": "object", "properties": { "id": { "type": "integer", - "format": "int64" + "example": 1 }, - "login": { + "url": { "type": "string", - "nullable": true + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" }, - "email": { + "ping_url": { "type": "string", - "nullable": true - }, - "role": { - "type": "string" - }, - "created_at": { - "type": "string" + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" }, - "failed_at": { + "deliveries_url": { "type": "string", - "nullable": true + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" }, - "failed_reason": { + "name": { "type": "string", - "nullable": true + "example": "web" }, - "inviter": { - "title": "Simple User", - "description": "A GitHub user.", + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "\"http://example.com/2\"" }, - "type": { + "insecure_ssl": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "\"0\"" }, - "starred_at": { + "content_type": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "\"form\"" }, - "user_view_type": { + "secret": { "type": "string", - "example": "public" + "example": "\"********\"" } - }, - "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" - ] - }, - "team_count": { - "type": "integer" + } }, - "node_id": { + "updated_at": { "type": "string", - "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + "format": "date-time", + "example": "2011-09-06T20:39:23Z" }, - "invitation_teams_url": { + "created_at": { "type": "string", - "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + "format": "date-time", + "example": "2011-09-06T17:26:27Z" }, - "invitation_source": { - "type": "string", - "example": "\"member\"" + "type": { + "type": "string" } }, "required": [ "id", - "login", - "email", - "role", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", "created_at", - "inviter", - "team_count", - "invitation_teams_url", - "node_id" + "updated_at" ] }, "examples": { "default": { "value": { "id": 1, - "login": "monalisa", - "node_id": "MDQ6VXNlcjE=", - "email": "octocat@github.com", - "role": "direct_member", - "created_at": "2016-11-30T06:46:10-08:00", - "inviter": { - "login": "other_user", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/other_user_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/other_user", - "html_url": "https://github.com/other_user", - "followers_url": "https://api.github.com/users/other_user/followers", - "following_url": "https://api.github.com/users/other_user/following{/other_user}", - "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", - "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", - "organizations_url": "https://api.github.com/users/other_user/orgs", - "repos_url": "https://api.github.com/users/other_user/repos", - "events_url": "https://api.github.com/users/other_user/events{/privacy}", - "received_events_url": "https://api.github.com/users/other_user/received_events", - "type": "User", - "site_admin": false + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" }, - "team_count": 2, - "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", - "invitation_source": "member" + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" } } } } + }, + "headers": { + "Location": { + "example": "https://api.github.com/orgs/octocat/hooks/1", + "schema": { + "type": "string" + } + } } }, "422": { @@ -96600,25 +93493,24 @@ } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "members" + "subcategory": "webhooks" } } }, - "/orgs/{org}/invitations/{invitation_id}": { - "delete": { - "summary": "Cancel an organization invitation", - "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "/orgs/{org}/hooks/{hook_id}": { + "get": { + "summary": "Get an organization webhook", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/cancel-invitation", + "operationId": "orgs/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation" + "url": "https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook" }, "parameters": [ { @@ -96631,8 +93523,8 @@ } }, { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", + "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.", "in": "path", "required": true, "schema": { @@ -96641,8 +93533,388 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + }, + "name": { + "type": "string", + "example": "web" + }, + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { + "type": "string", + "example": "\"0\"" + }, + "content_type": { + "type": "string", + "example": "\"form\"" + }, + "secret": { + "type": "string", + "example": "\"********\"" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + } + } + } + } + }, + "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": "webhooks" + } + }, + "patch": { + "summary": "Update an organization webhook", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook.", + "properties": { + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] + } + }, + "required": [ + "url" + ] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + }, + "name": { + "type": "string", + "example": "\"web\"" + } + } + }, + "examples": { + "default": { + "value": { + "active": true, + "events": [ + "pull_request" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + }, + "name": { + "type": "string", + "example": "web" + }, + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { + "type": "string", + "example": "\"0\"" + }, + "content_type": { + "type": "string", + "example": "\"form\"" + }, + "secret": { + "type": "string", + "example": "\"********\"" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "name": "web", + "events": [ + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + } + } + } + } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", @@ -96741,25 +94013,22 @@ } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "members" + "subcategory": "webhooks" } - } - }, - "/orgs/{org}/invitations/{invitation_id}/teams": { - "get": { - "summary": "List organization invitation teams", - "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", + }, + "delete": { + "summary": "Delete an organization webhook", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/list-invitation-teams", + "operationId": "orgs/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-organization-invitation-teams" + "url": "https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook" }, "parameters": [ { @@ -96772,244 +94041,18 @@ } }, { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", + "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.", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "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": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -97042,21 +94085,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "members" + "subcategory": "webhooks" } } }, - "/orgs/{org}/issue-types": { + "/orgs/{org}/hooks/{hook_id}/config": { "get": { - "summary": "List issue types for an organization", - "description": "Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.", + "summary": "Get a webhook configuration for an organization", + "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/list-issue-types", + "operationId": "orgs/get-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization" + "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -97067,6 +94110,15 @@ "schema": { "type": "string" } + }, + { + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { @@ -97075,113 +94127,47 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 410, - "node_id": "IT_kwDNAd3NAZo", - "name": "Task", - "description": "A specific piece of work", - "created_at": "2024-12-11T14:39:09Z", - "updated_at": "2024-12-11T14:39:09Z" - }, - { - "id": 411, - "node_id": "IT_kwDNAd3NAZs", - "name": "Bug", - "description": "An unexpected problem or behavior", - "created_at": "2024-12-11T14:39:09Z", - "updated_at": "2024-12-11T14:39:09Z" - } - ] - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "message": { - "type": "string" + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" }, - "documentation_url": { - "type": "string" + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" }, - "url": { - "type": "string" + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" }, - "status": { - "type": "string" + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] + } + } + }, + "examples": { + "default": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" } } } @@ -97193,19 +94179,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "issue-types" + "subcategory": "webhooks" } }, - "post": { - "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "patch": { + "summary": "Update a webhook configuration for an organization", + "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/create-issue-type", + "operationId": "orgs/update-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization" + "url": "https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -97216,56 +94202,62 @@ "schema": { "type": "string" } + }, + { + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { - "name": { - "description": "Name of the issue type.", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the issue type is enabled at the organization level.", - "type": "boolean" + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" }, - "description": { - "description": "Description of the issue type.", + "content_type": { "type": "string", - "nullable": true + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" }, - "color": { - "description": "Color for the issue type.", + "secret": { "type": "string", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] } - }, - "required": [ - "name", - "is_enabled" - ] + } }, "examples": { "default": { + "summary": "Update an existing webhook", "value": { - "name": "Epic", - "description": "An issue type for a multi-week tracking of work", - "is_enabled": true, - "color": "green" + "url": "http://example.com/webhook", + "content_type": "json", + "insecure_ssl": "0", + "secret": "********" } } } @@ -97278,130 +94270,47 @@ "content": { "application/json": { "schema": { - "title": "Issue Type", - "description": "The type of issue.", + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", - "nullable": true, "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { + "url": { "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" }, - "created_at": { + "content_type": { "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" }, - "updated_at": { + "secret": { "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "insecure_ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + } }, "examples": { "default": { "value": { - "id": 410, - "node_id": "IT_kwDNAd3NAZo", - "name": "Task", - "description": "A specific piece of work", - "created_at": "2024-12-11T14:39:09Z", - "updated_at": "2024-12-11T14:39:09Z" - } - } - } - } - } - }, - "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 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" - } + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" } } } @@ -97413,21 +94322,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "issue-types" + "subcategory": "webhooks" } } }, - "/orgs/{org}/issue-types/{issue_type_id}": { - "put": { - "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/hooks/{hook_id}/deliveries": { + "get": { + "summary": "List deliveries for an organization webhook", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/update-issue-type", + "operationId": "orgs/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization" + "url": "https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" }, "parameters": [ { @@ -97440,151 +94349,538 @@ } }, { - "name": "issue_type_id", - "description": "The unique identifier of the issue type.", + "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.", "in": "path", "required": true, "schema": { "type": "integer" } + }, + { + "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": "cursor", + "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "description": "Name of the issue type.", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the issue type is enabled at the organization level.", - "type": "boolean" - }, - "description": { - "description": "Description of the issue type.", - "type": "string", - "nullable": true - }, - "color": { - "description": "Color for the issue type.", - "type": "string", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Simple webhook delivery", + "description": "Delivery made by a webhook, without request and response information.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the webhook delivery.", + "type": "integer", + "format": "int64", + "example": 42 + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + }, + "delivered_at": { + "description": "Time when the webhook delivery occurred.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z" + }, + "redelivery": { + "description": "Whether the webhook delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Describes the response returned after attempting the delivery.", + "type": "string", + "example": "failed to connect" + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", + "nullable": true + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "format": "int64", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "format": "int64", + "example": 123, + "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + } + }, + "required": [ + "id", + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id" + ] } }, - "required": [ - "name", - "is_enabled" - ] + "examples": { + "default": { + "value": [ + { + "id": 12345678, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-03T00:57:16Z", + "redelivery": false, + "duration": 0.27, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "throttled_at": "2019-06-03T00:57:16Z" + }, + { + "id": 123456789, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-04T00:57:16Z", + "redelivery": true, + "duration": 0.28, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "throttled_at": null + } + ] + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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": "Epic", - "description": "An issue type for a multi-week tracking of work", - "is_enabled": true, - "color": "green" + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } } } } } } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + "get": { + "summary": "Get a webhook delivery for an organization webhook", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "delivery_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Issue Type", - "description": "The type of issue.", + "title": "Webhook delivery", + "description": "Delivery made by a webhook.", "type": "object", - "nullable": true, "properties": { "id": { + "description": "Unique identifier of the delivery.", "type": "integer", - "description": "The unique identifier of the issue type." + "example": 42 }, - "node_id": { + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", "type": "string", - "description": "The node identifier of the issue type." + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" }, - "name": { + "delivered_at": { + "description": "Time when the delivery was delivered.", "type": "string", - "description": "The name of the issue type." + "format": "date-time", + "example": "2021-05-12T20:33:44Z" }, - "description": { + "redelivery": { + "description": "Whether the delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Description of the status of the attempted delivery", "type": "string", - "description": "The description of the issue type.", - "nullable": true + "example": "failed to connect" }, - "color": { + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", "nullable": true }, - "created_at": { + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", "type": "string", - "description": "The time the issue type created.", - "format": "date-time" + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true }, - "updated_at": { + "url": { + "description": "The URL target of the delivery.", "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" + "example": "https://www.example.com" }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "request": { + "type": "object", + "properties": { + "headers": { + "description": "The request headers sent with the webhook delivery.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The webhook payload.", + "type": "object", + "nullable": true, + "additionalProperties": true + } + }, + "required": [ + "headers", + "payload" + ] + }, + "response": { + "type": "object", + "properties": { + "headers": { + "description": "The response headers received when the delivery was made.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The response payload received.", + "type": "string", + "nullable": true, + "additionalProperties": true + } + }, + "required": [ + "headers", + "payload" + ] } }, "required": [ "id", - "node_id", - "name", - "description" + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id", + "request", + "response" ] }, "examples": { "default": { "value": { - "id": 410, - "node_id": "IT_kwDNAd3NAZo", - "name": "Task", - "description": "A specific piece of work", - "created_at": "2024-12-11T14:39:09Z", - "updated_at": "2024-12-11T14:39:09Z" + "id": 12345678, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-03T00:57:16Z", + "redelivery": false, + "duration": 0.27, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "url": "https://www.example.com", + "throttled_at": "2019-06-03T00:57:16Z", + "request": { + "headers": { + "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "Accept": "*/*", + "X-GitHub-Hook-ID": "42", + "User-Agent": "GitHub-Hookshot/b8c71d8", + "X-GitHub-Event": "issues", + "X-GitHub-Hook-Installation-Target-ID": "123", + "X-GitHub-Hook-Installation-Target-Type": "repository", + "content-type": "application/json", + "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" + }, + "payload": { + "action": "opened", + "issue": { + "body": "foo" + }, + "repository": { + "id": 123 + } + } + }, + "response": { + "headers": { + "Content-Type": "text/html;charset=utf-8" + }, + "payload": "ok" + } } } } } } }, - "404": { - "description": "Resource not found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -97606,6 +94902,40 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } }, @@ -97614,8 +94944,8 @@ "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -97631,7 +94961,46 @@ "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -97644,19 +95013,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "issue-types" + "subcategory": "webhooks" } - }, - "delete": { - "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for an organization webhook", + "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], - "operationId": "orgs/delete-issue-type", + "operationId": "orgs/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization" + "url": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -97669,8 +95040,16 @@ } }, { - "name": "issue_type_id", - "description": "The unique identifier of the issue type.", + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "delivery_id", "in": "path", "required": true, "schema": { @@ -97679,16 +95058,88 @@ } ], "responses": { - "204": { - "description": "Response" + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Validation Error", + "description": "Validation Error", "type": "object", "required": [ "message", @@ -97704,13 +95155,97 @@ "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}/pings": { + "post": { + "summary": "Ping an organization webhook", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/ping-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -97743,21 +95278,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "issue-types" + "subcategory": "webhooks" } } }, - "/orgs/{org}/issues": { + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { "get": { - "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "summary": "Get route stats by actor", + "description": "Get API request count statistics for an actor broken down by route within a specified time frame.", "tags": [ - "issues" + "orgs" ], - "operationId": "issues/list-for-org", + "operationId": "api-insights/get-route-stats-by-actor", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor" }, "parameters": [ { @@ -97770,69 +95305,232 @@ } }, { - "name": "filter", - "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", - "in": "query", - "required": false, + "name": "actor_type", + "in": "path", + "description": "The type of the actor", + "required": true, "schema": { "type": "string", "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "default": "assigned" + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" + ] } }, { - "name": "state", - "description": "Indicates the state of the issues to return.", + "name": "actor_id", + "in": "path", + "description": "The ID of the actor", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", - "all" + "asc", + "desc" ], - "default": "open" + "default": "desc" } }, { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "name": "sort", + "description": "The property to sort the results by.", "in": "query", "required": false, "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "http_method", + "api_route", + "total_request_count" + ], + "default": "total_request_count" + } } }, { - "name": "type", - "description": "Can be the name of an issue type.", + "name": "api_route_substring", "in": "query", + "description": "Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.", "required": false, "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Route Stats", + "description": "API Insights usage route stats for an actor", + "type": "array", + "items": { + "type": "object", + "properties": { + "http_method": { + "description": "The HTTP method", + "type": "string" + }, + "api_route": { + "description": "The API path's route template", + "type": "string" + }, + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "http_method": "GET", + "api_route": "/repositories/:repository_id", + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/subject-stats": { + "get": { + "summary": "Get subject stats", + "description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-subject-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-subject-stats" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "sort", - "description": "What to sort results by.", + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "comments" - ], - "default": "created" + "type": "string" + } + }, + { + "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 + } + }, + { + "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 } }, { @@ -97850,31 +95548,427 @@ } }, { - "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "subject_name", + "total_request_count" + ], + "default": "total_request_count" + } + } + }, + { + "name": "subject_name_substring", + "in": "query", + "description": "Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Subject Stats", + "description": "API Insights usage subject stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "subject_type": { + "type": "string" + }, + "subject_name": { + "type": "string" + }, + "subject_id": { + "type": "integer", + "format": "int64" + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "subject_type": "installation", + "subject_id": 954453, + "subject_name": "GitHub Actions", + "integration_id": 124345, + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/summary-stats": { + "get": { + "summary": "Get summary stats", + "description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + }, + "examples": { + "default": { + "value": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + "get": { + "summary": "Get summary stats by user", + "description": "Get overall statistics of API requests within the organization for a user.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "user_id", + "in": "path", + "description": "The ID of the user to query for stats", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + }, + "examples": { + "default": { + "value": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get summary stats by actor", + "description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "actor_type", + "in": "path", + "description": "The type of the actor", + "required": true, "schema": { "type": "string", - "format": "date-time" + "enum": [ + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" + ] } }, { - "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).\"", + "name": "actor_id", + "in": "path", + "description": "The ID of the actor", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + }, + "examples": { + "default": { + "value": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/time-stats": { + "get": { + "summary": "Get time stats", + "description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } }, { - "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).\"", + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "schema": { - "type": "integer", - "default": 1 + "type": "string" + } + }, + { + "name": "timestamp_increment", + "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", + "in": "query", + "required": true, + "schema": { + "type": "string" } } ], @@ -97884,375 +95978,581 @@ "content": { "application/json": { "schema": { + "title": "Time Stats", + "description": "API Insights usage time stats for an organization", "type": "array", "items": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { - "id": { + "timestamp": { + "type": "string" + }, + "total_request_count": { "type": "integer", "format": "int64" }, - "node_id": { - "type": "string" + "rate_limited_request_count": { + "type": "integer", + "format": "int64" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "timestamp": "2024-09-11T15:00:00Z", + "total_request_count": 34225, + "rate_limited_request_count": 0 }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" + { + "timestamp": "2024-09-11T15:05:00Z", + "total_request_count": 10587, + "rate_limited_request_count": 18 }, - "repository_url": { - "type": "string", - "format": "uri" + { + "timestamp": "2024-09-11T15:10:00Z", + "total_request_count": 43587, + "rate_limited_request_count": 14 }, - "labels_url": { + { + "timestamp": "2024-09-11T15:15:00Z", + "total_request_count": 19463, + "rate_limited_request_count": 4 + }, + { + "timestamp": "2024-09-11T15:20:00Z", + "total_request_count": 60542, + "rate_limited_request_count": 3 + }, + { + "timestamp": "2024-09-11T15:25:00Z", + "total_request_count": 55872, + "rate_limited_request_count": 23 + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + "get": { + "summary": "Get time stats by user", + "description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "user_id", + "in": "path", + "description": "The ID of the user to query for stats", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "timestamp_increment", + "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Time Stats", + "description": "API Insights usage time stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { "type": "string" }, - "comments_url": { - "type": "string", - "format": "uri" + "total_request_count": { + "type": "integer", + "format": "int64" }, - "events_url": { - "type": "string", - "format": "uri" + "rate_limited_request_count": { + "type": "integer", + "format": "int64" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "timestamp": "2024-09-11T15:00:00Z", + "total_request_count": 34225, + "rate_limited_request_count": 0 }, - "html_url": { - "type": "string", - "format": "uri" + { + "timestamp": "2024-09-11T15:05:00Z", + "total_request_count": 10587, + "rate_limited_request_count": 18 }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" + { + "timestamp": "2024-09-11T15:10:00Z", + "total_request_count": 43587, + "rate_limited_request_count": 14 }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", + { + "timestamp": "2024-09-11T15:15:00Z", + "total_request_count": 19463, + "rate_limited_request_count": 4 + }, + { + "timestamp": "2024-09-11T15:20:00Z", + "total_request_count": 60542, + "rate_limited_request_count": 3 + }, + { + "timestamp": "2024-09-11T15:25:00Z", + "total_request_count": 55872, + "rate_limited_request_count": 23 + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get time stats by actor", + "description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "actor_type", + "in": "path", + "description": "The type of the actor", + "required": true, + "schema": { + "type": "string", + "enum": [ + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" + ] + } + }, + { + "name": "actor_id", + "in": "path", + "description": "The ID of the actor", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "timestamp_increment", + "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Time Stats", + "description": "API Insights usage time stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { "type": "string" }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", - "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] + "total_request_count": { + "type": "integer", + "format": "int64" }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "rate_limited_request_count": { + "type": "integer", + "format": "int64" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "timestamp": "2024-09-11T15:00:00Z", + "total_request_count": 34225, + "rate_limited_request_count": 0 + }, + { + "timestamp": "2024-09-11T15:05:00Z", + "total_request_count": 10587, + "rate_limited_request_count": 18 + }, + { + "timestamp": "2024-09-11T15:10:00Z", + "total_request_count": 43587, + "rate_limited_request_count": 14 + }, + { + "timestamp": "2024-09-11T15:15:00Z", + "total_request_count": 19463, + "rate_limited_request_count": 4 + }, + { + "timestamp": "2024-09-11T15:20:00Z", + "total_request_count": 60542, + "rate_limited_request_count": 3 + }, + { + "timestamp": "2024-09-11T15:25:00Z", + "total_request_count": 55872, + "rate_limited_request_count": 23 + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/user-stats/{user_id}": { + "get": { + "summary": "Get user stats", + "description": "Get API usage statistics within an organization for a user broken down by the type of access.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-user-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-user-stats" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "user_id", + "in": "path", + "description": "The ID of the user to query for stats", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "subject_name", + "total_request_count" + ], + "default": "total_request_count" + } + } + }, + { + "name": "actor_name_substring", + "in": "query", + "description": "Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "User Stats", + "description": "API Insights usage stats for a user", + "type": "array", + "items": { + "type": "object", + "properties": { + "actor_type": { "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "actor_name": { + "type": "string" + }, + "actor_id": { + "type": "integer", + "format": "int64" + }, + "integration_id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "oauth_application_id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { "type": "string", "nullable": true }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "actor_type": "oauth_app", + "actor_id": 954453, + "actor_name": "GitHub Actions", + "oauth_application_id": 1245, + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/installation": { + "get": { + "summary": "Get an organization installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-org-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" + }, + "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": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "account": { + "nullable": true, + "anyOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -98376,62 +96676,1507 @@ "url" ] }, - "nullable": true + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/app/installations/1/access_tokens" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/installation/repositories" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/organizations/github/settings/installations/1" + }, + "app_id": { + "type": "integer", + "example": 1 + }, + "client_id": { + "type": "string", + "example": "Iv1.ab1112223334445c" + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "example": "Organization" + }, + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + } }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "example": "github-actions" + }, + "suspended_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "contact_email": { + "type": "string", + "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", + "nullable": true + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "account": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/orgs/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "all", + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "client_id": "Iv1.ab1112223334445c", + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "created_at": "2018-02-09T20:51:14Z", + "updated_at": "2018-02-09T20:51:14Z", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/orgs/{org}/installations": { + "get": { + "summary": "List app installations for an organization", + "description": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\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:read` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-app-installations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-app-installations-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/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": { + "type": "object", + "required": [ + "total_count", + "installations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "installations": { + "type": "array", + "items": { + "title": "Installation", + "description": "Installation", "type": "object", "properties": { - "url": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "account": { + "nullable": true, + "anyOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "example": "https://api.github.com/app/installations/1/access_tokens" }, - "html_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + "example": "https://api.github.com/installation/repositories" }, - "labels_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + "example": "https://github.com/organizations/github/settings/installations/1" }, - "id": { + "app_id": { "type": "integer", - "example": 1002604 + "example": 1 }, - "node_id": { + "client_id": { "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + "example": "Iv1.ab1112223334445c" }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" }, - "state": { - "description": "The state of the milestone.", - "example": "open", + "target_type": { "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" + "example": "Organization" }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } }, - "description": { + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { "type": "string", - "example": "Tracking milestone for version 1.0", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": "string", + "example": "config.yaml", "nullable": true }, - "creator": { + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "example": "github-actions" + }, + "suspended_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -98556,120 +98301,549 @@ ], "nullable": true }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { + "suspended_at": { "type": "string", "format": "date-time", - "example": "2013-02-12T13:22:01Z", "nullable": true }, - "due_on": { + "contact_email": { "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", + "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", "nullable": true } }, "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", "id", - "node_id", - "labels_url", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", "html_url", - "number", - "open_issues", - "state", - "title", - "url", + "repositories_url", + "events", + "account", + "permissions", "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true + "updated_at", + "suspended_by", + "suspended_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "installations": [ + { + "id": 25381, + "account": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true + "repository_selection": "selected", + "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/octo-org/settings/installations/25381", + "app_id": 2218, + "target_id": 6811672, + "target_type": "Organization", + "permissions": { + "deployments": "write", + "metadata": "read", + "pull_requests": "read", + "statuses": "read" }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } + "events": [ + "deployment", + "deployment_status" + ], + "created_at": "2017-05-16T08:47:09.000-07:00", + "updated_at": "2017-06-06T11:23:23.000-07:00", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/interaction-limits": { + "get": { + "summary": "Get interaction restrictions for an organization", + "description": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.", + "tags": [ + "interactions" + ], + "operationId": "interactions/get-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-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": { + "anyOf": [ + { + "title": "Interaction Limits", + "description": "Interaction limit settings.", + "type": "object", + "properties": { + "limit": { + "type": "string", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "example": "collaborators_only", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ] }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true + "origin": { + "type": "string", + "example": "repository" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "example": "2018-08-17T04:18:39Z" + } }, - "created_at": { + "required": [ + "limit", + "origin", + "expires_at" + ] + }, + { + "type": "object", + "properties": {}, + "additionalProperties": false + } + ] + }, + "examples": { + "default": { + "value": { + "limit": "collaborators_only", + "origin": "organization", + "expires_at": "2018-08-17T04:18:39Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + }, + "put": { + "summary": "Set interaction restrictions for an organization", + "description": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.", + "tags": [ + "interactions" + ], + "operationId": "interactions/set-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-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": { + "title": "Interaction Restrictions", + "description": "Limit interactions to a specific type of user for a specified duration", + "type": "object", + "properties": { + "limit": { + "type": "string", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "example": "collaborators_only", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ] + }, + "expiry": { + "type": "string", + "description": "The duration of the interaction restriction. Default: `one_day`.", + "example": "one_month", + "enum": [ + "one_day", + "three_days", + "one_week", + "one_month", + "six_months" + ] + } + }, + "required": [ + "limit" + ] + }, + "examples": { + "default": { + "value": { + "limit": "collaborators_only", + "expiry": "one_month" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Interaction Limits", + "description": "Interaction limit settings.", + "type": "object", + "properties": { + "limit": { + "type": "string", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "example": "collaborators_only", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ] + }, + "origin": { + "type": "string", + "example": "repository" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "example": "2018-08-17T04:18:39Z" + } + }, + "required": [ + "limit", + "origin", + "expires_at" + ] + }, + "examples": { + "default": { + "value": { + "limit": "collaborators_only", + "origin": "organization", + "expires_at": "2018-08-17T04:18:39Z" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Remove interaction restrictions for an organization", + "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", + "tags": [ + "interactions" + ], + "operationId": "interactions/remove-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-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" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/invitations": { + "get": { + "summary": "List pending organization invitations", + "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub\nmember, the `login` field in the return hash will be `null`.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pending-invitations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#list-pending-organization-invitations" + }, + "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/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 + } + }, + { + "name": "role", + "description": "Filter invitations by their member role.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "admin", + "direct_member", + "billing_manager", + "hiring_manager" + ], + "default": "all" + } + }, + { + "name": "invitation_source", + "description": "Filter invitations by their invitation source.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "member", + "scim" + ], + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { + "email": { "type": "string", - "format": "date-time" + "nullable": true }, - "draft": { - "type": "boolean" + "role": { + "type": "string" }, - "closed_by": { + "created_at": { + "type": "string" + }, + "failed_at": { + "type": "string", + "nullable": true + }, + "failed_reason": { + "type": "string", + "nullable": true + }, + "inviter": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -98791,1225 +98965,34 @@ "subscriptions_url", "type", "url" - ], - "nullable": true - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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" ] }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] + "team_count": { + "type": "integer" }, - "author_association": { - "title": "author_association", + "node_id": { "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + "invitation_teams_url": { + "type": "string", + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] + "invitation_source": { + "type": "string", + "example": "\"member\"" } }, "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", + "login", + "email", + "role", "created_at", - "updated_at" + "inviter", + "team_count", + "invitation_teams_url", + "node_id" ] } }, @@ -100018,263 +99001,36 @@ "value": [ { "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "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 - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "login": "octocat", + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "avatar_url": "https://github.com/images/error/other_user_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", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false }, - "assignees": [ - { - "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 - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "repository": { - "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 - }, - "author_association": "COLLABORATOR" + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" } ] } @@ -100319,23 +99075,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "issues", - "subcategory": "issues" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" } - } - }, - "/orgs/{org}/members": { - "get": { - "summary": "List organization members", - "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", + }, + "post": { + "summary": "Create an organization invitation", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "orgs" ], - "operationId": "orgs/list-members", + "operationId": "orgs/create-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#list-organization-members" + "url": "https://docs.github.com/rest/orgs/members#create-an-organization-invitation" }, "parameters": [ { @@ -100346,224 +99100,424 @@ "schema": { "type": "string" } - }, - { - "name": "filter", - "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "2fa_insecure", - "all" - ], - "default": "all" - } - }, - { - "name": "role", - "description": "Filter members returned by their role.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "admin", - "member" - ], - "default": "all" - } - }, - { - "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 - } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "invitee_id": { + "type": "integer", + "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting." + }, + "email": { + "type": "string", + "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user." + }, + "role": { + "type": "string", + "description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.", + "enum": [ + "admin", + "direct_member", + "billing_manager", + "reinstate" + ], + "default": "direct_member" + }, + "team_ids": { + "type": "array", + "description": "Specify IDs for the teams you want to invite new members to.", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "email": "octocat@github.com", + "role": "direct_member", + "team_ids": [ + 12, + 26 + ] + } + } + } + } + } + }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "nullable": true + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": "string", + "nullable": true + }, + "failed_reason": { + "type": "string", + "nullable": true + }, + "inviter": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user_view_type": { - "type": "string", - "example": "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" + ] }, - "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" - ] - } + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + }, + "invitation_teams_url": { + "type": "string", + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + }, + "invitation_source": { + "type": "string", + "example": "\"member\"" + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] }, "examples": { "default": { - "value": [ - { - "login": "octocat", + "value": { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "inviter": { + "login": "other_user", "id": 1, "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "avatar_url": "https://github.com/images/error/other_user_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", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", "type": "User", "site_admin": false + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } - ] + } } } } - }, - "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": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/invitations/{invitation_id}": { + "delete": { + "summary": "Cancel an organization invitation", + "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "tags": [ + "orgs" + ], + "operationId": "orgs/cancel-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" }, "422": { "description": "Validation failed, or the endpoint has been spammed.", @@ -100633,9 +99587,36 @@ } } } + }, + "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": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", @@ -100643,17 +99624,17 @@ } } }, - "/orgs/{org}/members/{username}": { + "/orgs/{org}/invitations/{invitation_id}/teams": { "get": { - "summary": "Check organization membership for a user", - "description": "Check if a user is, publicly or privately, a member of the organization.", + "summary": "List organization invitation teams", + "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", "tags": [ "orgs" ], - "operationId": "orgs/check-membership-for-user", + "operationId": "orgs/list-invitation-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user" + "url": "https://docs.github.com/rest/orgs/members#list-organization-invitation-teams" }, "parameters": [ { @@ -100666,24 +99647,239 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "invitation_id", + "description": "The unique identifier of the invitation.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" + } + }, + { + "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": { - "204": { - "description": "Response if requester is an organization member and user is a member" - }, - "302": { - "description": "Response if requester is not an organization member", + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ] + } + } + } + }, "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members/pezra", + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } @@ -100691,7 +99887,30 @@ } }, "404": { - "description": "Not Found if requester is an organization member and user is not a member" + "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": { @@ -100700,17 +99919,19 @@ "category": "orgs", "subcategory": "members" } - }, - "delete": { - "summary": "Remove an organization member", - "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.\n\n> [!NOTE]\n> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.", + } + }, + "/orgs/{org}/issue-types": { + "get": { + "summary": "List issue types for an organization", + "description": "Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/remove-member", + "operationId": "orgs/list-issue-types", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/members#remove-an-organization-member" + "url": "https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization" }, "parameters": [ { @@ -100721,10 +99942,150 @@ "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 411, + "node_id": "IT_kwDNAd3NAZs", + "name": "Bug", + "description": "An unexpected problem or behavior", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ] + } + } + } + } }, + "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": "issue-types" + } + }, + "post": { + "summary": "Create issue type for an organization", + "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization" + }, + "parameters": [ { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -100732,12 +100093,142 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue type.", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the issue type is enabled at the organization level.", + "type": "boolean" + }, + "description": { + "description": "Description of the issue type.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the issue type.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + } + }, + "required": [ + "name", + "is_enabled" + ] + }, + "examples": { + "default": { + "value": { + "name": "Epic", + "description": "An issue type for a multi-week tracking of work", + "is_enabled": true, + "color": "green" + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "examples": { + "default": { + "value": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + } + } + } + } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -100761,47 +100252,288 @@ } } } + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "orgs", - "subcategory": "members" + "subcategory": "issue-types" } } }, - "/orgs/{org}/members/{username}/codespaces": { - "get": { - "summary": "List codespaces for a user in organization", - "description": "Lists the codespaces that a member of an organization has for repositories in that organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/issue-types/{issue_type_id}": { + "put": { + "summary": "Update issue type for an organization", + "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "codespaces" + "orgs" ], - "operationId": "codespaces/get-codespaces-for-user-in-org", + "operationId": "orgs/update-issue-type", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization" + "url": "https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization" }, "parameters": [ { - "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", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } }, { - "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", + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue type.", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the issue type is enabled at the organization level.", + "type": "boolean" + }, + "description": { + "description": "Description of the issue type.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the issue type.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + } + }, + "required": [ + "name", + "is_enabled" + ] + }, + "examples": { + "default": { + "value": { + "name": "Epic", + "description": "An issue type for a multi-week tracking of work", + "is_enabled": true, + "color": "green" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "examples": { + "default": { + "value": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + } + } + } + } + }, + "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 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" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + } + }, + "delete": { + "summary": "Delete issue type for an organization", + "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization" + }, + "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -100812,1415 +100544,2443 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Response" + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", "required": [ - "total_count", - "codespaces" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "codespaces": { + "documentation_url": { + "type": "string" + }, + "errors": { "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + } + } + }, + "/orgs/{org}/issues": { + "get": { + "summary": "List organization issues assigned to the authenticated user", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "repos", + "all" + ], + "default": "assigned" + } + }, + { + "name": "state", + "description": "Indicates the state of the issues to return.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "What to sort results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "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": { + "type": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "title": "Codespace", - "description": "A codespace.", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { "type": "integer", "format": "int64", "example": 1 }, - "name": { - "description": "Automatically generated name of this codespace.", + "node_id": { "type": "string", - "example": "monalisa-octocat-hello-world-g4wpq6h95q" + "example": "MDQ6VXNlcjE=" }, - "display_name": { - "description": "Display name for this codespace.", + "avatar_url": { "type": "string", - "example": "bookish space pancake", - "nullable": true + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", + "gravatar_id": { "type": "string", - "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "billable_owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" }, - "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" - ] + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "email": { + "nullable": true, + "type": "string" }, - "description": { + "login": { "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" + "example": "octocat" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "archive_url": { + "node_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "MDQ6VXNlcjE=" }, - "assignees_url": { + "avatar_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "blobs_url": { + "gravatar_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "branches_url": { + "url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "collaborators_url": { + "html_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "format": "uri", + "example": "https://github.com/octocat" }, - "comments_url": { + "followers_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "commits_url": { + "following_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "compare_url": { + "gists_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "contents_url": { + "starred_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "contributors_url": { + "subscriptions_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/users/octocat/subscriptions" }, - "deployments_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/users/octocat/orgs" }, - "downloads_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "forks_url": { + "received_events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/users/octocat/received_events" }, - "git_commits_url": { + "type": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "User" }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "site_admin": { + "type": "boolean" }, - "git_tags_url": { + "starred_at": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" + "example": "\"2020-07-09T00:17:55Z\"" }, - "issue_comment_url": { + "user_view_type": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "mit" }, - "issues_url": { + "name": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "MIT License" }, - "keys_url": { + "url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "labels_url": { + "spdx_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "nullable": true, + "example": "MIT" }, - "languages_url": { + "node_id": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "MDc6TGljZW5zZW1pdA==" }, - "merges_url": { + "html_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "pull": { + "type": "boolean" }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "triage": { + "type": "boolean" }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "push": { + "type": "boolean" }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "ssh_url": { + "email": { + "nullable": true, "type": "string" }, - "stargazers_url": { + "login": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "octocat" }, - "statuses_url": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "MDQ6VXNlcjE=" }, - "subscribers_url": { + "avatar_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://github.com/images/error/octocat_happy.gif" }, - "subscription_url": { + "gravatar_id": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "tags_url": { + "url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/users/octocat" }, - "teams_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://github.com/octocat" }, - "trees_url": { + "followers_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "mirror_url": { + "following_url": { "type": "string", - "nullable": true + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "hooks_url": { + "gists_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "homepage": { + "starred_url": { "type": "string", - "nullable": true + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "language": { + "subscriptions_url": { "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "pushed_at": { + "organizations_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "created_at": { + "repos_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "updated_at": { + "events_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "role_name": { + "received_events_url": { "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "watchers": { - "type": "integer", - "example": 0 + "type": { + "type": "string", + "example": "User" }, - "allow_forking": { + "site_admin": { "type": "boolean" }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "user_view_type": { + "type": "string", + "example": "public" } }, "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", + "avatar_url", "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "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", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", "url" ] }, - "machine": { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "example": "standardLinux" - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "example": "4 cores, 16 GB RAM, 64 GB storage" - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "example": "linux" - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "example": 68719476736 - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "example": 17179869184 - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "example": 4 - }, - "prebuild_availability": { - "type": "string", - "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", - "example": "ready", - "enum": [ - "none", - "ready", - "in_progress" - ], - "nullable": true - } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ], - "nullable": true + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", + "html_url": { "type": "string", - "example": ".devcontainer/example/devcontainer.json", - "nullable": true + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": "boolean", - "example": false, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true }, - "created_at": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "updated_at": { + "archive_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "last_used_at": { - "description": "Last known time this codespace was started.", + "assignees_url": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "state": { - "description": "State of this codespace.", - "enum": [ - "Unknown", - "Created", - "Queued", - "Provisioning", - "Available", - "Awaiting", - "Unavailable", - "Deleted", - "Moved", - "Shutdown", - "Archived", - "Starting", - "ShuttingDown", - "Failed", - "Exporting", - "Updating", - "Rebuilding" - ], - "example": "Available", - "type": "string" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "url": { - "description": "API URL for this codespace.", + "branches_url": { "type": "string", - "format": "uri" + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "git_status": { - "description": "Details about the codespace's git repository.", - "type": "object", - "properties": { - "ahead": { - "description": "The number of commits the local repository is ahead of the remote.", - "type": "integer", - "example": 0 - }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "example": 0 - }, - "has_unpushed_changes": { - "description": "Whether the local repository has unpushed changes.", - "type": "boolean" - }, - "has_uncommitted_changes": { - "description": "Whether the local repository has uncommitted changes.", - "type": "boolean" - }, - "ref": { - "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", - "type": "string", - "example": "main" - } - } + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "location": { - "description": "The initally assigned location of a new codespace.", - "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "example": "WestUs2", - "type": "string" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": "integer", - "example": 60, - "nullable": true + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "web_url": { - "description": "URL to access this codespace on the web.", + "compare_url": { "type": "string", - "format": "uri" + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "machines_url": { - "description": "API URL to access available alternate machine types for this codespace.", + "contents_url": { "type": "string", - "format": "uri" + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "start_url": { - "description": "API URL to start this codespace.", + "contributors_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "stop_url": { - "description": "API URL to stop this codespace.", + "deployments_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "publish_url": { - "description": "API URL to publish this codespace to a new repository.", + "downloads_url": { "type": "string", "format": "uri", - "nullable": true + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { "type": "string", "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, - "recent_folders": { + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { "type": "array", "items": { "type": "string" } }, - "runtime_constraints": { - "type": "object", - "properties": { - "allowed_port_privacy_settings": { - "description": "The privacy settings a user can select from when forwarding a port.", - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - } + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, - "pending_operation": { - "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, "type": "boolean", - "nullable": true + "example": true }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", - "type": "string", - "nullable": true + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", "nullable": true }, - "retention_period_minutes": { - "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", - "type": "integer", - "example": 60, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", "nullable": true }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "updated_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T20:01:12Z", + "example": "2011-01-26T19:14:43Z", "nullable": true }, - "last_known_stop_notice": { - "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", - "example": "you've used 100% of your spending limit for Codespaces", - "nullable": true + "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", + "example": 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", + "example": "\"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", - "environment_id", + "notifications_url", "owner", - "billable_owner", - "repository", - "machine", - "prebuild", - "created_at", - "updated_at", - "last_used_at", - "state", - "url", - "git_status", - "location", - "idle_timeout_minutes", - "web_url", - "machines_url", - "start_url", - "stop_url", + "private", "pulls_url", - "recent_folders" + "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": 3, - "codespaces": [ - { - "id": 1, - "name": "monalisa-octocat-hello-world-g4wpq6h95q", - "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "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 + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" }, - "billable_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 + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" }, - "repository": { - "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 + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } }, - "prebuild": false, - "devcontainer_path": ".devcontainer/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", - "recent_folders": [] + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - { + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", "id": 1, - "name": "monalisa-octocat-hello-world-3f89ada1j3", - "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", - "owner": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -102239,8 +102999,19 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "billable_owner": { + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -102260,109 +103031,30 @@ "type": "User", "site_admin": false }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer/foobar/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", - "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": [] + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, @@ -102383,209 +103075,116 @@ "type": "User", "site_admin": false }, - "billable_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 - }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 + "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 }, - "prebuild": false, - "devcontainer_path": ".devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "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" }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", - "recent_folders": [] - } - ] - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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" - } + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "author_association": "COLLABORATOR" + } + ] } } } - } - }, - "403": { - "description": "Forbidden", - "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" } } } @@ -102620,22 +103219,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "category": "issues", + "subcategory": "issues" } } }, - "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { - "delete": { - "summary": "Delete a codespace from the organization", - "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/members": { + "get": { + "summary": "List organization members", + "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", "tags": [ - "codespaces" + "orgs" ], - "operationId": "codespaces/delete-from-organization", + "operationId": "orgs/list-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization" + "url": "https://docs.github.com/rest/orgs/members#list-organization-members" }, "parameters": [ { @@ -102648,77 +103247,235 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, + "name": "filter", + "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "2fa_disabled", + "2fa_insecure", + "all" + ], + "default": "all" } }, { - "name": "codespace_name", - "in": "path", - "required": true, - "description": "The name of the codespace.", + "name": "role", + "description": "Filter members returned by their role.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "all", + "admin", + "member" + ], + "default": "all" + } + }, + { + "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": { - "202": { - "description": "Accepted", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "type": "object" + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + } }, "examples": { "default": { - "value": null + "value": [ + { + "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 + } + ] } } } - } - }, - "304": { - "description": "Not modified" - }, - "500": { - "description": "Internal Error", - "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" } } } }, - "401": { - "description": "Requires authentication", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -102726,45 +103483,160 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/members/{username}": { + "get": { + "summary": "Check organization membership for a user", + "description": "Check if a user is, publicly or privately, a member of the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if requester is an organization member and user is a member" + }, + "302": { + "description": "Response if requester is not an organization member", + "headers": { + "Location": { + "example": "https://api.github.com/orgs/github/public_members/pezra", "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" } } } }, "404": { - "description": "Resource not found", + "description": "Not Found if requester is an organization member and user is not a member" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove an organization member", + "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.\n\n> [!NOTE]\n> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-member", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#remove-an-organization-member" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -102792,37 +103664,46 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" } } }, - "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { - "post": { - "summary": "Stop a codespace for an organization user", - "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/members/{username}/codespaces": { + "get": { + "summary": "List codespaces for a user in organization", + "description": "Lists the codespaces that a member of an organization has for repositories in that organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], - "operationId": "codespaces/stop-in-organization", + "operationId": "codespaces/get-codespaces-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user" + "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, + "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": "string" + "type": "integer", + "default": 30 } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "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 + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { @@ -102830,10 +103711,10 @@ } }, { - "name": "codespace_name", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, - "description": "The name of the codespace.", "schema": { "type": "string" } @@ -102846,500 +103727,2518 @@ "application/json": { "schema": { "type": "object", - "title": "Codespace", - "description": "A codespace.", + "required": [ + "total_count", + "codespaces" + ], "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "description": "Automatically generated name of this codespace.", - "type": "string", - "example": "monalisa-octocat-hello-world-g4wpq6h95q" - }, - "display_name": { - "description": "Display name for this codespace.", - "type": "string", - "example": "bookish space pancake", - "nullable": true - }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", - "type": "string", - "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "nullable": true - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - "billable_owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] + "total_count": { + "type": "integer" }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "codespaces": { + "type": "array", + "items": { + "type": "object", + "title": "Codespace", + "description": "A codespace.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "example": "monalisa-octocat-hello-world-g4wpq6h95q" + }, + "display_name": { + "description": "Display name for this codespace.", + "type": "string", + "example": "bookish space pancake", + "nullable": true + }, + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": "string", + "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "nullable": true + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "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" + ] + }, + "machine": { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "example": "standardLinux" + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "example": "4 cores, 16 GB RAM, 64 GB storage" + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "example": "linux" + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "example": 68719476736 + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "example": 17179869184 + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "example": 4 + }, + "prebuild_availability": { + "type": "string", + "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", + "example": "ready", + "enum": [ + "none", + "ready", + "in_progress" + ], + "nullable": true + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ], + "nullable": true + }, + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", + "type": "string", + "example": ".devcontainer/example/devcontainer.json", + "nullable": true + }, + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": "boolean", + "example": false, + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "last_used_at": { + "description": "Last known time this codespace was started.", + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "state": { + "description": "State of this codespace.", + "enum": [ + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "example": "Available", + "type": "string" + }, + "url": { + "description": "API URL for this codespace.", + "type": "string", + "format": "uri" + }, + "git_status": { + "description": "Details about the codespace's git repository.", + "type": "object", + "properties": { + "ahead": { + "description": "The number of commits the local repository is ahead of the remote.", + "type": "integer", + "example": 0 + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "example": 0 + }, + "has_unpushed_changes": { + "description": "Whether the local repository has unpushed changes.", + "type": "boolean" + }, + "has_uncommitted_changes": { + "description": "Whether the local repository has uncommitted changes.", + "type": "boolean" + }, + "ref": { + "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", + "type": "string", + "example": "main" + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "example": "WestUs2", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": "integer", + "example": 60, + "nullable": true + }, + "web_url": { + "description": "URL to access this codespace on the web.", + "type": "string", + "format": "uri" + }, + "machines_url": { + "description": "API URL to access available alternate machine types for this codespace.", + "type": "string", + "format": "uri" + }, + "start_url": { + "description": "API URL to start this codespace.", + "type": "string", + "format": "uri" + }, + "stop_url": { + "description": "API URL to stop this codespace.", + "type": "string", + "format": "uri" + }, + "publish_url": { + "description": "API URL to publish this codespace to a new repository.", + "type": "string", + "format": "uri", + "nullable": true + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": "string", + "format": "uri", + "nullable": true + }, + "recent_folders": { + "type": "array", + "items": { + "type": "string" + } + }, + "runtime_constraints": { + "type": "object", + "properties": { + "allowed_port_privacy_settings": { + "description": "The privacy settings a user can select from when forwarding a port.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + }, + "pending_operation": { + "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", + "type": "boolean", + "nullable": true + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": "string", + "nullable": true + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": "string", + "nullable": true + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer", + "example": 60, + "nullable": true + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": "string", + "format": "date-time", + "example": "2011-01-26T20:01:12Z", + "nullable": true + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": "string", + "example": "you've used 100% of your spending limit for Codespaces", + "nullable": true + } + }, + "required": [ + "id", + "name", + "environment_id", + "owner", + "billable_owner", + "repository", + "machine", + "prebuild", + "created_at", + "updated_at", + "last_used_at", + "state", + "url", + "git_status", + "location", + "idle_timeout_minutes", + "web_url", + "machines_url", + "start_url", + "stop_url", + "pulls_url", + "recent_folders" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "codespaces": [ + { + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/foobar/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "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": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-f8adfad99a", + "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", + "recent_folders": [] + } + ] + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": false, + "category": "codespaces", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { + "delete": { + "summary": "Delete a codespace from the organization", + "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-from-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "codespace_name", + "in": "path", + "required": true, + "description": "The name of the codespace.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": false, + "category": "codespaces", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { + "post": { + "summary": "Stop a codespace for an organization user", + "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/stop-in-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "codespace_name", + "in": "path", + "required": true, + "description": "The name of the codespace.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Codespace", + "description": "A codespace.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "example": "monalisa-octocat-hello-world-g4wpq6h95q" + }, + "display_name": { + "description": "Display name for this codespace.", + "type": "string", + "example": "bookish space pancake", + "nullable": true + }, + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": "string", + "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "nullable": true + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", "example": "http://api.github.com/repos/octocat/Hello-World/events" }, "forks_url": { @@ -104344,7 +107243,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -139625,6 +142524,639 @@ } } }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "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": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update organization pattern configurations", + "description": "Updates the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "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": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, "/orgs/{org}/security-advisories": { "get": { "summary": "List repository security advisories for an organization", @@ -171763,199 +175295,1044 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true, + "allowed_actions": "selected" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/access": { + "get": { + "summary": "Get the level of access for workflows outside of the repository", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-access-to-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_level": { + "type": "string", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", + "enum": [ + "none", + "user", + "organization" + ] + } + }, + "required": [ + "access_level" + ] + }, + "examples": { + "default": { + "value": { + "access_level": "organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set the level of access for workflows outside of the repository", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-workflow-access-to-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_level": { + "type": "string", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", + "enum": [ + "none", + "user", + "organization" + ] + } + }, + "required": [ + "access_level" + ] + }, + "examples": { + "default": { + "value": { + "access_level": "organization" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for a repository", + "description": "Gets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "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": { + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "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" + } + }, + "put": { + "summary": "Set artifact and log retention settings for a repository", + "description": "Sets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "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": { + "default": { + "summary": "Set retention days", + "value": { + "days": 90 + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for a repository", + "description": "Gets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for a repository", + "description": "Sets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for a repository", + "description": "Gets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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 + } + } + } + } + } + }, + "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, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for a repository", + "description": "Sets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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": { - "enabled": { + "run_workflows_from_fork_pull_requests": { "type": "boolean", - "description": "Whether GitHub Actions is enabled on the repository." + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "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" - ] + "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." } - }, - "required": [ - "enabled" - ] + } }, "examples": { "default": { "value": { - "enabled": true, - "allowed_actions": "selected" + "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 } } } } } }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/repos/{owner}/{repo}/actions/permissions/access": { - "get": { - "summary": "Get the level of access for workflows outside of the repository", - "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-workflow-access-to-repository", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "Empty response for successful settings update" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "access_level": { - "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", - "enum": [ - "none", - "user", - "organization" - ] - } - }, - "required": [ - "access_level" - ] - }, - "examples": { - "default": { - "value": { - "access_level": "organization" + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set the level of access for workflows outside of the repository", - "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/set-workflow-access-to-repository", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "access_level": { - "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", - "enum": [ - "none", - "user", - "organization" - ] - } - }, - "required": [ - "access_level" - ] - }, - "examples": { - "default": { - "value": { - "access_level": "organization" + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], "category": "actions", "subcategory": "permissions" } @@ -278083,6 +282460,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -297907,6 +302308,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -300480,6 +304905,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -302817,496 +307266,3872 @@ "url" ] }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "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 + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + }, + "delete": { + "summary": "Delete an issue comment", + "description": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.", + "tags": [ + "issues" + ], + "operationId": "issues/delete-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#delete-an-issue-comment" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + "get": { + "summary": "List reactions for an issue comment", + "description": "List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", + "tags": [ + "reactions" + ], + "operationId": "reactions/list-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { + "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": { + "type": "array", + "items": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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": "reactions", + "subcategory": "reactions" + } + }, + "post": { + "summary": "Create reaction for an issue comment", + "description": "Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", + "tags": [ + "reactions" + ], + "operationId": "reactions/create-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "heart" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Reaction exists", + "content": { + "application/json": { + "schema": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + } + } + } + } + }, + "201": { + "description": "Reaction created", + "content": { + "application/json": { + "schema": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "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 + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete an issue comment reaction", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "reaction_id", + "description": "The unique identifier of the reaction.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/issues/events": { + "get": { + "summary": "List issue events for a repository", + "description": "Lists events for a repository.", + "tags": [ + "issues" + ], + "operationId": "issues/list-events-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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/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": { + "type": "array", + "items": { + "title": "Issue Event", + "description": "Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEwOklzc3VlRXZlbnQx" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "event": { + "type": "string", + "example": "closed" + }, + "commit_id": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "commit_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" + "additionalProperties": { + "type": "string" }, - "avatar_url": { - "type": "string", - "format": "uri" + "example": { + "issues": "read", + "deployments": "write" } }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } }, - "contents": { - "type": "string" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - "deployments": { - "type": "string" - } + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "additionalProperties": { - "type": "string" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "user": { - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - } - } - } - } - } - }, - "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": { + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ], + "nullable": true + }, + "label": { + "title": "Issue Event Label", + "description": "Issue Event Label", "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + }, "required": [ - "code" - ], + "name", + "color" + ] + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", "properties": { - "resource": { + "name": { + "nullable": true, "type": "string" }, - "field": { + "email": { + "nullable": true, "type": "string" }, - "message": { - "type": "string" + "login": { + "type": "string", + "example": "octocat" }, - "code": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "index": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "comments" - } - }, - "delete": { - "summary": "Delete an issue comment", - "description": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.", - "tags": [ - "issues" - ], - "operationId": "issues/delete-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#delete-an-issue-comment" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "comments" - } - } - }, - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { - "get": { - "summary": "List reactions for an issue comment", - "description": "List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", - "tags": [ - "reactions" - ], - "operationId": "reactions/list-for-issue-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "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": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "user": { + "assigner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -303431,818 +311256,132 @@ ], "nullable": true }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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": "reactions", - "subcategory": "reactions" - } - }, - "post": { - "summary": "Create reaction for an issue comment", - "description": "Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-issue-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "examples": { - "default": { - "value": { - "content": "heart" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Reaction exists", - "content": { - "application/json": { - "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - }, - "201": { - "description": "Reaction created", - "content": { - "application/json": { - "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "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 - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - }, - "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": { + "review_requester": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "name": { + "nullable": true, "type": "string" }, - "field": { + "email": { + "nullable": true, "type": "string" }, - "message": { - "type": "string" + "login": { + "type": "string", + "example": "octocat" }, - "code": { - "type": "string" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "index": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete an issue comment reaction", - "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-issue-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "path", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "reactions", - "subcategory": "reactions" - } - } - }, - "/repos/{owner}/{repo}/issues/events": { - "get": { - "summary": "List issue events for a repository", - "description": "Lists events for a repository.", - "tags": [ - "issues" - ], - "operationId": "issues/list-events-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. 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/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": { - "type": "array", - "items": { - "title": "Issue Event", - "description": "Issue Event", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEwOklzc3VlRXZlbnQx" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true }, - "actor": { + "requested_reviewer": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -304367,96 +311506,1447 @@ ], "nullable": true }, - "event": { - "type": "string", - "example": "closed" + "requested_team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] }, - "commit_id": { - "type": "string", - "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true + "dismissed_review": { + "title": "Issue Event Dismissed Review", + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": "string", + "nullable": true + }, + "dismissal_commit_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" + ] }, - "commit_url": { + "milestone": { + "title": "Issue Event Milestone", + "description": "Issue Event Milestone", + "type": "object", + "properties": { + "title": { + "type": "string" + } + }, + "required": [ + "title" + ] + }, + "project_card": { + "title": "Issue Event Project Card", + "description": "Issue Event Project Card", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "url", + "id", + "project_url", + "project_id", + "column_name" + ] + }, + "rename": { + "title": "Issue Event Rename", + "description": "Issue Event Rename", + "type": "object", + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + }, + "required": [ + "from", + "to" + ] + }, + "author_association": { + "title": "author_association", "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, - "created_at": { + "lock_reason": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "nullable": true }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "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 + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { + "resource": { "type": "string" }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { + "field": { "type": "string" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" + "message": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri" + "code": { + "type": "string" }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, + "index": { "type": "integer" }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", - "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/events/{event_id}": { + "get": { + "summary": "Get an issue event", + "description": "Gets a single event by the event id.", + "tags": [ + "issues" + ], + "operationId": "issues/get-event", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/events#get-an-issue-event" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "event_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue Event", + "description": "Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEwOklzc3VlRXZlbnQx" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "event": { + "type": "string", + "example": "closed" + }, + "commit_id": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "commit_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" - }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", - "type": "string", - "nullable": true + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -304578,2337 +313068,3505 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { "oneOf": [ { - "type": "string" + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] }, { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true }, - "node_id": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" }, - "url": { + "website_url": { + "description": "The enterprise's website URL.", "type": "string", + "nullable": true, "format": "uri" }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, "name": { - "type": "string" + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" }, - "description": { + "slug": { + "description": "The slug url identifier for the enterprise.", "type": "string", - "nullable": true + "example": "octo-business" }, - "color": { + "created_at": { "type": "string", - "nullable": true + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" }, - "default": { - "type": "boolean" + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" } - } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] } ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "name": { - "nullable": true, + "issues": { "type": "string" }, - "email": { - "nullable": true, + "checks": { "type": "string" }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "metadata": { + "type": "string" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "contents": { + "type": "string" }, - "user_view_type": { - "type": "string", - "example": "public" + "deployments": { + "type": "string" } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", + "additionalProperties": { "type": "string" }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true + "example": { + "issues": "read", + "deployments": "write" } }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "body_html": { - "type": "string" + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } }, - "body_text": { - "type": "string" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } }, - "timeline_url": { - "type": "string", - "format": "uri" + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ], + "nullable": true + }, + "label": { + "title": "Issue Event Label", + "description": "Issue Event Label", + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "color" + ] + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assigner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "review_requester": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "requested_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "requested_team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" }, - "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" - ] + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "dismissed_review": { + "title": "Issue Event Dismissed Review", + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": "string", + "nullable": true + }, + "dismissal_commit_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" + ] + }, + "milestone": { + "title": "Issue Event Milestone", + "description": "Issue Event Milestone", + "type": "object", + "properties": { + "title": { + "type": "string" + } + }, + "required": [ + "title" + ] + }, + "project_card": { + "title": "Issue Event Project Card", + "description": "Issue Event Project Card", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "url", + "id", + "project_url", + "project_id", + "column_name" + ] + }, + "rename": { + "title": "Issue Event Rename", + "description": "Issue Event Rename", + "type": "object", + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + }, + "required": [ + "from", + "to" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "lock_reason": { + "type": "string", + "nullable": true + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "additionalProperties": { + "email": { + "nullable": true, "type": "string" }, - "example": { - "issues": "read", - "deployments": "write" + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } + "checks": { + "type": "string" }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } + "metadata": { + "type": "string" }, - "required": [ - "total", - "completed", - "percent_completed" - ] - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at" - ], - "nullable": true - }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "color": { - "type": "string", - "nullable": true - } - }, - "required": [ - "name", - "color" - ] - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, + "additionalProperties": { "type": "string" }, - "email": { - "nullable": true, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } }, - "assigner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "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 + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true } + ], + "assignee": { + "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 }, - "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" + "assignees": [ + { + "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 + } ], - "nullable": true - }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 }, - "type": { - "type": "string", - "example": "User" + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "performed_via_github_app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "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", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "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", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, - "site_admin": { - "type": "boolean" + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "events": [ + "push", + "pull_request" + ] + }, + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}": { + "get": { + "summary": "Get an issue", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#get-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" }, - "user_view_type": { - "type": "string", - "example": "public" + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "requested_reviewer": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -307030,620 +316688,1736 @@ "subscriptions_url", "type", "url" - ], - "nullable": true + ] }, - "requested_team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } + "email": { + "nullable": true, + "type": "string" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } }, - "dismissed_review": { - "title": "Issue Event Dismissed Review", - "type": "object", - "properties": { - "state": { - "type": "string" - }, - "review_id": { - "type": "integer" - }, - "dismissal_message": { - "type": "string", - "nullable": true - }, - "dismissal_commit_id": { - "type": "string", - "nullable": true - } + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } }, - "milestone": { - "title": "Issue Event Milestone", - "description": "Issue Event Milestone", - "type": "object", - "properties": { - "title": { - "type": "string" - } + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "required": [ - "title" - ] + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "project_card": { - "title": "Issue Event Project Card", - "description": "Issue Event Project Card", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "project_url": { - "type": "string", - "format": "uri" - }, - "project_id": { - "type": "integer" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "column_name": { - "type": "string" + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "previous_column_name": { - "type": "string" - } + "required": [ + "admin", + "pull", + "push" + ] }, - "required": [ - "url", - "id", - "project_url", - "project_id", - "column_name" - ] - }, - "rename": { - "title": "Issue Event Rename", - "description": "Issue Event Rename", - "type": "object", - "properties": { - "from": { - "type": "string" + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "to": { + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { "type": "string" } }, - "required": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "lock_reason": { - "type": "string", - "nullable": true + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" + } + } + } }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" }, - "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "email": { + "nullable": true, + "type": "string" }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "contents": { - "type": "string" + "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "deployments": { - "type": "string" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "additionalProperties": { + "checks": { "type": "string" }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { "type": "string" } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" } }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - } + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] }, - "required": [ - "id", - "node_id", - "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at" - ] - } + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] }, "examples": { "default": { - "value": [ - { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -307662,176 +318436,119 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "issue": { - "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "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 - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "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 - }, - "assignees": [ - { - "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 - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR", - "state_reason": "completed" } - } - ] + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -307839,76 +318556,64 @@ "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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" } } } } } + }, + "304": { + "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "events" + "subcategory": "issues" } - } - }, - "/repos/{owner}/{repo}/issues/events/{event_id}": { - "get": { - "summary": "Get an issue event", - "description": "Gets a single event by the event id.", + }, + "patch": { + "summary": "Update an issue", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/get-event", + "operationId": "issues/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/events#get-an-issue-event" + "url": "https://docs.github.com/rest/issues/issues#update-an-issue" }, "parameters": [ { @@ -307930,7 +318635,8 @@ } }, { - "name": "event_id", + "name": "issue_number", + "description": "The number that identifies the issue.", "in": "path", "required": true, "schema": { @@ -307938,31 +318644,207 @@ } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "description": "The title of the issue.", + "nullable": true + }, + "body": { + "type": "string", + "description": "The contents of the issue.", + "nullable": true + }, + "assignee": { + "type": "string", + "nullable": true, + "description": "Username to assign to this issue. **This field is closing down.**" + }, + "state": { + "type": "string", + "description": "The open or closed state of the issue.", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "enum": [ + "completed", + "not_planned", + "duplicate", + "reopened" + ], + "nullable": true, + "description": "The reason for the state change. Ignored unless `state` is changed.", + "example": "not_planned" + }, + "milestone": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer", + "description": "The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped." + } + ], + "nullable": true + }, + "labels": { + "type": "array", + "description": "Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + } + } + ] + } + }, + "assignees": { + "type": "array", + "description": "Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.", + "nullable": true, + "example": "Epic" + } + } + }, + "examples": { + "default": { + "value": { + "title": "Found a bug", + "body": "I'm having a problem with this.", + "assignees": [ + "octocat" + ], + "milestone": 1, + "state": "open", + "labels": [ + "bug" + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Issue Event", - "description": "Issue Event", + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { - "type": "string", - "example": "MDEwOklzc3VlRXZlbnQx" + "type": "string" }, "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + "format": "uri" }, - "actor": { + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -308087,96 +318969,358 @@ ], "nullable": true }, - "event": { - "type": "string", - "example": "closed" - }, - "commit_id": { - "type": "string", - "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true - }, - "commit_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "example": 1 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "repository_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://github.com/octocat" }, - "labels_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "comments_url": { + "following_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", "type": "string", - "nullable": true, "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] + "open", + "closed" + ], + "default": "open" }, "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "description": "The title of the milestone.", + "example": "v1.0", "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "description": { "type": "string", + "example": "Tracking milestone for version 1.0", "nullable": true }, - "user": { + "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -308301,596 +319445,409 @@ ], "nullable": true }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } + "open_issues": { + "type": "integer", + "example": 4 }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", "nullable": true }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", "nullable": true }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 + "example": "mit" }, - "closed_issues": { - "type": "integer", - "example": 8 + "name": { + "type": "string", + "example": "MIT License" }, - "created_at": { + "url": { "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "updated_at": { + "spdx_id": { "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" + "nullable": true, + "example": "MIT" }, - "closed_at": { + "node_id": { "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true + "example": "MDc6TGljZW5zZW1pdA==" }, - "due_on": { + "html_url": { "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true + "format": "uri" } }, "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", + "key", + "name", "url", - "created_at", - "updated_at" + "spdx_id", + "node_id" ], "nullable": true }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { + "forks": { "type": "integer" }, - "pull_request": { + "permissions": { "type": "object", "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true + "admin": { + "type": "boolean" }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true + "pull": { + "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true + "triage": { + "type": "boolean" }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true + "push": { + "type": "boolean" }, - "url": { - "type": "string", - "format": "uri", - "nullable": true + "maintain": { + "type": "boolean" } }, "required": [ - "diff_url", - "html_url", - "patch_url", - "url" + "admin", + "pull", + "push" ] }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -309012,174 +319969,546 @@ "subscriptions_url", "type", "url" - ], + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true }, - "body_html": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "body_text": { + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { "type": "string" }, - "timeline_url": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", - "format": "uri" + "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)." }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", + "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", + "example": 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", + "example": "\"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", - "nullable": true, + "description": "The status of the code search index for this repository", "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" + "lexical_search_ok": { + "type": "boolean" }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "lexical_commit_sha": { + "type": "string" } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + } + } + }, + "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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -309303,957 +320632,813 @@ "url" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", - "description": "The status of the code search index for this repository", "properties": { - "lexical_search_ok": { - "type": "boolean" + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true }, - "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" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" }, - "checks": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" }, - "metadata": { - "type": "string" + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "contents": { - "type": "string" + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" }, - "deployments": { - "type": "string" + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" ] }, - "author_association": { - "title": "author_association", + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "example": "The description of the app.", + "nullable": true }, - "reactions": { - "title": "Reaction Rollup", + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" + "issues": { + "type": "string" }, - "heart": { - "type": "integer" + "checks": { + "type": "string" }, - "hooray": { - "type": "integer" + "metadata": { + "type": "string" }, - "eyes": { - "type": "integer" + "contents": { + "type": "string" }, - "rocket": { - "type": "integer" + "deployments": { + "type": "string" } }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } + "additionalProperties": { + "type": "string" }, - "required": [ - "total", - "completed", - "percent_completed" - ] + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", + "owner", + "name", + "description", + "external_url", + "html_url", "created_at", - "updated_at" - ], - "nullable": true + "updated_at", + "permissions", + "events" + ] }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", "type": "object", "properties": { - "name": { - "type": "string", - "nullable": true + "blocked_by": { + "type": "integer" }, - "color": { - "type": "string", - "nullable": true + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" } }, "required": [ - "name", - "color" + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + } + }, + "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" }, - "assignee": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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": "issues", + "subcategory": "issues" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + "post": { + "summary": "Add assignees to an issue", + "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", + "tags": [ + "issues" + ], + "operationId": "issues/add-assignees", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "type": "array", + "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "assignees": [ + "hubot", + "other_user" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -310378,7 +321563,52 @@ ], "nullable": true }, - "assigner": { + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -310503,132 +321733,426 @@ ], "nullable": true }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, - "email": { - "nullable": true, - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, - "login": { + "labels_url": { "type": "string", - "example": "octocat" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { "type": "integer", - "format": "int64", - "example": 1 + "example": 1002604 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, - "gravatar_id": { + "state": { + "description": "The state of the milestone.", + "example": "open", "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "enum": [ + "open", + "closed" + ], + "default": "open" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" }, - "html_url": { + "description": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "Tracking milestone for version 1.0", + "nullable": true }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "open_issues": { + "type": "integer", + "example": 4 }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "closed_issues": { + "type": "integer", + "example": 8 }, - "starred_url": { + "created_at": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "date-time", + "example": "2011-04-10T20:09:31Z" }, - "subscriptions_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, - "organizations_url": { + "closed_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true }, - "repos_url": { + "due_on": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "nullable": true }, - "received_events_url": { + "diff_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "nullable": true }, - "type": { + "html_url": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "nullable": true }, - "starred_at": { + "patch_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri", + "nullable": true }, - "user_view_type": { + "url": { "type": "string", - "example": "public" + "format": "uri", + "nullable": true } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "diff_url", "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "patch_url", "url" - ], + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", "nullable": true }, - "requested_reviewer": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -310753,39 +322277,151 @@ ], "nullable": true }, - "requested_team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": "object", + "nullable": true, "properties": { "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue type." }, "node_id": { - "type": "string" + "type": "string", + "description": "The node identifier of the issue type." }, "name": { - "type": "string" - }, - "slug": { - "type": "string" + "type": "string", + "description": "The name of the issue type." }, "description": { "type": "string", + "description": "The description of the issue type.", "nullable": true }, - "privacy": { - "type": "string" + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, - "notification_setting": { - "type": "string" + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" }, - "permission": { - "type": "string" + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" }, "permissions": { "type": "object", "properties": { + "admin": { + "type": "boolean" + }, "pull": { "type": "boolean" }, @@ -310797,243 +322433,649 @@ }, "maintain": { "type": "boolean" - }, - "admin": { - "type": "boolean" } }, "required": [ + "admin", "pull", - "triage", - "push", - "maintain", - "admin" + "push" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { - "description": "Unique identifier of the team", "type": "integer", + "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VGVhbTE=" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { - "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" + "example": "https://api.github.com/users/octocat" }, - "members_url": { + "html_url": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "format": "uri", + "example": "https://github.com/octocat" }, - "name": { - "description": "Name of the team", + "followers_url": { "type": "string", - "example": "Justice League" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "description": { - "description": "Description of the team", + "following_url": { "type": "string", - "nullable": true, - "example": "A great team." + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "permission": { - "description": "Permission that the team will have for its repositories", + "gists_url": { "type": "string", - "example": "admin" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "privacy": { - "description": "The level of privacy this team should have", + "starred_url": { "type": "string", - "example": "closed" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "notification_setting": { - "description": "The notification setting the team has set", + "subscriptions_url": { "type": "string", - "example": "notifications_enabled" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "example": "https://api.github.com/users/octocat/orgs" }, - "repositories_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "example": "https://api.github.com/users/octocat/repos" }, - "slug": { + "events_url": { "type": "string", - "example": "justice-league" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - "dismissed_review": { - "title": "Issue Event Dismissed Review", - "type": "object", - "properties": { - "state": { + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "review_id": { - "type": "integer" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true }, - "dismissal_message": { + "created_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", "nullable": true }, - "dismissal_commit_id": { + "updated_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", "nullable": true - } - }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] - }, - "milestone": { - "title": "Issue Event Milestone", - "description": "Issue Event Milestone", - "type": "object", - "properties": { - "title": { + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { "type": "string" - } - }, - "required": [ - "title" - ] - }, - "project_card": { - "title": "Issue Event Project Card", - "description": "Issue Event Project Card", - "type": "object", - "properties": { - "url": { + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", - "format": "uri" + "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)." }, - "id": { - "type": "integer" + "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." }, - "project_url": { + "merge_commit_title": { "type": "string", - "format": "uri" + "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)." }, - "project_id": { + "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", + "example": 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" }, - "column_name": { - "type": "string" + "watchers": { + "type": "integer" }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "project_url", - "project_id", - "column_name" - ] - }, - "rename": { - "title": "Issue Event Rename", - "description": "Issue Event Rename", - "type": "object", - "properties": { - "from": { + "master_branch": { "type": "string" }, - "to": { - "type": "string" + "starred_at": { + "type": "string", + "example": "\"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": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "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" ] }, - "lock_reason": { - "type": "string", - "nullable": true - }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -311323,45 +323365,176 @@ "type": "string" } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { "type": "integer" } }, "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at" + "user", + "author_association", + "created_at", + "updated_at" ] }, "examples": { "default": { "value": { "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -311381,24 +323554,39 @@ "type": "User", "site_admin": false }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "issue": { + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { + "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 + }, + "assignees": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -311417,19 +323605,19 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -311449,198 +323637,47 @@ "type": "User", "site_admin": false }, - "assignees": [ - { - "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 - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "performed_via_github_app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "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", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "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" + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -311652,21 +323689,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "events" + "subcategory": "assignees" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}": { - "get": { - "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + }, + "delete": { + "summary": "Remove assignees from an issue", + "description": "Removes one or more assignees from an issue.", "tags": [ "issues" ], - "operationId": "issues/get", + "operationId": "issues/remove-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#get-an-issue" + "url": "https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue" }, "parameters": [ { @@ -311697,6 +323732,34 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "type": "array", + "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "assignees": [ + "hubot", + "other_user" + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", @@ -313803,6 +325866,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -313993,9 +326080,71 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + "get": { + "summary": "Check if a user can be assigned to a issue", + "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", + "tags": [ + "issues" + ], + "operationId": "issues/check-user-can-be-assigned-to-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "301": { - "description": "Moved permanently", + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "assignee", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if `assignee` can be assigned to `issue_number`" + }, + "404": { + "description": "Response if `assignee` can not be assigned to `issue_number`", "content": { "application/json": { "schema": { @@ -314019,6 +326168,701 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "get": { + "summary": "List issue comments", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-comments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#list-issue-comments" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "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": { + "type": "array", + "items": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "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 + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } }, "404": { "description": "Resource not found", @@ -314071,28 +326915,25 @@ } } } - }, - "304": { - "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "comments" } }, - "patch": { - "summary": "Update an issue", - "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "post": { + "summary": "Create an issue comment", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/update", + "operationId": "issues/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/rest/issues/comments#create-an-issue-comment" }, "parameters": [ { @@ -314124,124 +326965,25 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "The title of the issue.", - "nullable": true - }, "body": { "type": "string", - "description": "The contents of the issue.", - "nullable": true - }, - "assignee": { - "type": "string", - "nullable": true, - "description": "Username to assign to this issue. **This field is closing down.**" - }, - "state": { - "type": "string", - "description": "The open or closed state of the issue.", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": "string", - "enum": [ - "completed", - "not_planned", - "duplicate", - "reopened" - ], - "nullable": true, - "description": "The reason for the state change. Ignored unless `state` is changed.", - "example": "not_planned" - }, - "milestone": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped." - } - ], - "nullable": true - }, - "labels": { - "type": "array", - "description": "Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - } - } - } - ] - } - }, - "assignees": { - "type": "array", - "description": "Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.", - "nullable": true, - "example": "Epic" + "description": "The contents of the comment." } - } + }, + "required": [ + "body" + ] }, "examples": { "default": { "value": { - "title": "Found a bug", - "body": "I'm having a problem with this.", - "assignees": [ - "octocat" - ], - "milestone": 1, - "state": "open", - "labels": [ - "bug" - ] + "body": "Me too" } } } @@ -314249,16 +326991,18 @@ } }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the issue comment", + "example": 42, "type": "integer", "format": "int64" }, @@ -314266,62 +327010,25 @@ "type": "string" }, "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", "format": "uri" }, - "labels_url": { + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", "type": "string" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", + "body_text": { "type": "string" }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", - "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] - }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "body_html": { "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "html_url": { "type": "string", - "nullable": true + "format": "uri" }, "user": { "title": "Simple User", @@ -314426,201 +327133,939 @@ "example": "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" - ], - "nullable": true - }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "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 + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "schema": { + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + "get": { + "summary": "List dependencies an issue is blocked by", + "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": { + "type": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, "type": "string" }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } - ] - } - }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] } }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "assignees": { - "type": "array", - "items": { + "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -314742,64 +328187,12 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { + "assignees": { + "type": "array", + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -314921,1533 +328314,1686 @@ "subscriptions_url", "type", "url" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true + ] }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } + "nullable": true }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "locked": { + "type": "boolean" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } + "active_lock_reason": { + "type": "string", + "nullable": true }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "html_url": { + "type": "string", + "format": "uri", + "nullable": true }, - "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } }, - "topics": { - "type": "array", - "items": { + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } }, - "code_search_index_status": { - "type": "object", - "description": "The status of the code search index for this repository", - "properties": { - "lexical_search_ok": { - "type": "boolean" + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "lexical_commit_sha": { + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { "type": "string" } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "required": [ + "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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user_view_type": { - "type": "string", - "example": "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" + ] }, - "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "contents": { + "additionalProperties": { "type": "string" }, - "deployments": { - "type": "string" + "example": { + "issues": "read", + "deployments": "write" } }, - "additionalProperties": { - "type": "string" + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } }, - "example": { - "issues": "read", - "deployments": "write" + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } }, - "rocket": { - "type": "integer" - } + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at" - ] + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } }, "examples": { "default": { - "value": { - "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "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 - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "login": "octocat", + "value": [ + { "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 - }, - "assignees": [ - { + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -316466,19 +330012,19 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -316498,165 +330044,110 @@ "type": "User", "site_admin": false }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "closed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - } - } - } - }, - "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" + "assignees": [ + { + "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 + } ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } + ] } } } - } - }, - "403": { - "description": "Forbidden", - "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" } } } @@ -316744,21 +330235,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "issue-dependencies" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + }, "post": { - "summary": "Add assignees to an issue", - "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", + "summary": "Add a dependency an issue is blocked by", + "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/add-assignees", + "operationId": "issues/add-blocked-by-dependency", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue" + "url": "https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -316790,28 +330279,25 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "assignees": { - "type": "array", - "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "items": { - "type": "string" - } + "issue_id": { + "type": "integer", + "description": "The id of the issue that blocks the current issue" } - } + }, + "required": [ + "issue_id" + ] }, "examples": { "default": { "value": { - "assignees": [ - "hubot", - "other_user" - ] + "issue_id": 1 } } } @@ -318924,6 +332410,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -319037,78 +332547,259 @@ "type": "User", "site_admin": false } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "closed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" } } } @@ -319117,22 +332808,25 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "assignees" + "subcategory": "issue-dependencies" } - }, + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { "delete": { - "summary": "Remove assignees from an issue", - "description": "Removes one or more assignees from an issue.", + "summary": "Remove dependency an issue is blocked by", + "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/remove-assignees", + "operationId": "issues/remove-dependency-blocked-by", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue" + "url": "https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -319161,36 +332855,17 @@ "schema": { "type": "integer" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "assignees": { - "type": "array", - "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "assignees": [ - "hubot", - "other_user" - ] - } - } - } + }, + { + "name": "issue_id", + "in": "path", + "description": "The id of the blocking issue to remove as a dependency", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { "200": { "description": "Response", @@ -321297,6 +334972,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -321487,71 +335186,173 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "assignees" - } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { - "get": { - "summary": "Check if a user can be assigned to a issue", - "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", - "tags": [ - "issues" - ], - "operationId": "issues/check-user-can-be-assigned-to-issue", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" + }, + "301": { + "description": "Moved permanently", + "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": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } } }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" + "401": { + "description": "Requires authentication", + "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": "assignee", - "in": "path", - "required": true, - "schema": { - "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" + } + } + } + } } - } - ], - "responses": { - "204": { - "description": "Response if `assignee` can be assigned to `issue_number`" }, "404": { - "description": "Response if `assignee` can not be assigned to `issue_number`", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -321578,24 +335379,25 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "assignees" + "subcategory": "issue-dependencies" } } }, - "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { "get": { - "summary": "List issue comments", - "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "summary": "List dependencies an issue is blocking", + "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/list-comments", + "operationId": "issues/list-dependencies-blocking", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#list-issue-comments" + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" }, "parameters": [ { @@ -321625,16 +335427,6 @@ "type": "integer" } }, - { - "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, { "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).\"", @@ -321662,13 +335454,11 @@ "schema": { "type": "array", "items": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the issue comment", - "example": 42, "type": "integer", "format": "int64" }, @@ -321676,26 +335466,63 @@ "type": "string" }, "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" + "repository_url": { + "type": "string", + "format": "uri" }, - "body_text": { + "labels_url": { "type": "string" }, - "body_html": { - "type": "string" + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, "user": { "title": "Simple User", "description": "A GitHub user.", @@ -321821,34 +335648,1517 @@ ], "nullable": true }, - "created_at": { + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { "type": "string", "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "format": "date-time" }, - "issue_url": { + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { "type": "string", "format": "uri" }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" ] }, "performed_via_github_app": { @@ -322160,6 +337470,22 @@ "events" ] }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, "reactions": { "title": "Reaction Rollup", "type": "object", @@ -322208,16 +337534,72 @@ "eyes", "rocket" ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", - "html_url", - "issue_url", - "author_association", - "user", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", + "user", + "author_association", "created_at", "updated_at" ] @@ -322228,10 +337610,17 @@ "value": [ { "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, @@ -322252,765 +337641,147 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "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": "issues", - "subcategory": "comments" - } - }, - "post": { - "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", - "tags": [ - "issues" - ], - "operationId": "issues/create-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/comments#create-an-issue-comment" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "The contents of the comment." - } - }, - "required": [ - "body" - ] - }, - "examples": { - "default": { - "value": { - "body": "Me too" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true } + ], + "assignee": { + "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 }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" + "assignees": [ + { + "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 } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" }, - "eyes": { - "type": "integer" + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "user": { - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - } + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + ] } } } }, "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { "type": "string" } } } }, - "403": { - "description": "Forbidden", + "301": { + "description": "Moved permanently", "content": { "application/json": { "schema": { @@ -323035,8 +337806,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -323061,77 +337832,8 @@ } } }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -323158,11 +337860,10 @@ } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "comments" + "subcategory": "issue-dependencies" } } }, @@ -336809,6 +351510,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -339271,6 +353996,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -341709,6 +356458,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -344246,6 +359019,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -354790,6 +369587,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -453320,6 +468141,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "type": "string" }, @@ -497419,6 +512264,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -527096,6 +541965,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -530077,6 +544970,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -533060,6 +547977,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -542409,6 +557350,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -545392,6 +560357,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -707729,6 +722718,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -711470,6 +726483,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -715235,6 +730272,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -719406,6 +734467,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -721537,6 +736622,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -725945,6 +741054,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -728076,6 +743209,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -732484,6 +747641,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -735344,6 +750525,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -739023,6 +754228,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -741883,6 +757112,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -744706,6 +759959,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -747596,6 +762873,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -750678,6 +765979,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -753578,6 +768903,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -756651,6 +772000,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -759575,6 +774948,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -762525,6 +777922,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -765401,6 +780822,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -768355,6 +783800,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -770308,6 +785777,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -773186,6 +788679,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -776089,6 +791606,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -778859,6 +794400,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -780828,6 +796393,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -783713,6 +799302,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -786756,6 +802369,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -789641,6 +805278,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -792589,6 +808250,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -795444,6 +811129,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -798328,6 +814037,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -885636,6 +901369,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -886402,6 +902330,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -887168,6 +903291,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -887987,6 +904305,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -892520,6 +909033,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1147289,6 +1163997,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1150149,6 +1166881,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1153825,6 +1170581,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1156685,6 +1173465,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1160361,6 +1177165,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1163221,6 +1180049,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1166897,6 +1183749,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1169757,6 +1186633,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 09d5733167..7797a67865 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -99,6 +99,8 @@ tags: description: Revoke compromised or leaked GitHub credentials. - name: campaigns description: Endpoints to manage campaigns via the REST API. +- name: projects + description: Endpoints to manage Projects using the REST API. servers: - url: https://api.github.com externalDocs: @@ -851,7 +853,7 @@ paths: - subscriptions_url - type - url - type: &281 + type: &286 type: string description: The type of credit the user is receiving. enum: @@ -984,7 +986,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &101 + schema: &104 title: Validation Error Simple description: Validation Error Simple type: object @@ -1017,7 +1019,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &604 + - &614 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1573,7 +1575,7 @@ paths: schema: type: integer default: 30 - - &174 + - &177 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1589,7 +1591,7 @@ paths: application/json: schema: type: array - items: &175 + items: &178 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1669,7 +1671,7 @@ paths: - installation_id - repository_id examples: - default: &176 + default: &179 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1728,7 +1730,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &100 + schema: &103 title: Validation Error description: Validation Error type: object @@ -1797,7 +1799,7 @@ paths: description: Response content: application/json: - schema: &177 + schema: &180 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1911,7 +1913,7 @@ paths: - request - response examples: - default: &178 + default: &181 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2841,7 +2843,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &239 + properties: &242 id: description: Unique identifier of the repository example: 42 @@ -3279,7 +3281,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &240 + required: &243 - archive_url - assignees_url - blobs_url @@ -5066,7 +5068,7 @@ paths: responses: '202': *39 '422': *7 - '500': &97 + '500': &100 description: Internal Error content: application/json: @@ -7391,7 +7393,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &145 + code_scanning_options: &148 type: object description: Security Configuration feature options for code scanning nullable: true @@ -7585,7 +7587,7 @@ paths: description: Response content: application/json: - schema: &147 + schema: &150 type: array description: A list of default code security configurations items: @@ -7601,7 +7603,7 @@ paths: default configuration: *43 examples: - default: &148 + default: &151 value: - default_for_new_repos: public configuration: @@ -7932,7 +7934,7 @@ paths: - *42 - *45 responses: - '204': &149 + '204': &152 description: A header with no content is returned. '400': *14 '403': *29 @@ -8059,7 +8061,7 @@ paths: default: value: default_for_new_repos: all - configuration: &146 + configuration: &149 value: id: 1325 target_type: organization @@ -8144,7 +8146,7 @@ paths: application/json: schema: type: array - items: &150 + items: &153 type: object description: Repositories associated with a code security configuration and attachment status @@ -8166,7 +8168,7 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: &94 + properties: &98 id: type: integer format: int64 @@ -8393,7 +8395,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &95 + required: &99 - archive_url - assignees_url - blobs_url @@ -8445,7 +8447,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &151 + repository: &154 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8539,7 +8541,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *42 - - &156 + - &159 name: state in: query description: |- @@ -8548,7 +8550,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &157 + - &160 name: severity in: query description: |- @@ -8557,7 +8559,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &158 + - &161 name: ecosystem in: query description: |- @@ -8566,14 +8568,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &159 + - &162 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &160 + - &163 name: epss_percentage in: query description: |- @@ -8585,7 +8587,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &161 + - &164 name: has in: query description: |- @@ -8599,7 +8601,7 @@ paths: type: string enum: - patch - - &162 + - &165 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8609,7 +8611,7 @@ paths: enum: - development - runtime - - &163 + - &166 name: sort in: query description: |- @@ -8627,7 +8629,7 @@ paths: - *48 - *40 - *41 - - &164 + - &167 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -8640,7 +8642,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &165 + - &168 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -8660,7 +8662,7 @@ paths: application/json: schema: type: array - items: &166 + items: &169 type: object description: A Dependabot alert. properties: @@ -8726,7 +8728,7 @@ paths: - unknown - direct - transitive - security_advisory: &454 + security_advisory: &464 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8945,13 +8947,13 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &139 + updated_at: &142 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &141 + dismissed_at: &144 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -8981,14 +8983,14 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &140 + fixed_at: &143 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &455 + auto_dismissed_at: &465 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9014,7 +9016,7 @@ paths: - repository additionalProperties: false examples: - default: &167 + default: &170 value: - number: 2 state: dismissed @@ -9361,7 +9363,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *42 - - &271 + - &274 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -9372,7 +9374,7 @@ paths: enum: - open - resolved - - &272 + - &275 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -9382,7 +9384,7 @@ paths: required: false schema: type: string - - &273 + - &276 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -9391,7 +9393,7 @@ paths: required: false schema: type: string - - &274 + - &277 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -9407,7 +9409,7 @@ paths: - *17 - *40 - *41 - - &275 + - &278 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -9416,7 +9418,7 @@ paths: required: false schema: type: string - - &276 + - &279 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -9425,7 +9427,7 @@ paths: schema: type: boolean default: false - - &277 + - &280 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -9434,7 +9436,7 @@ paths: schema: type: boolean default: false - - &278 + - &281 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -9450,7 +9452,7 @@ paths: application/json: schema: type: array - items: &279 + items: &282 type: object properties: number: *54 @@ -9469,14 +9471,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &582 + state: &592 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &583 + resolution: &593 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -9583,8 +9585,8 @@ paths: pull request. ' - oneOf: &584 - - &586 + oneOf: &594 + - &596 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -9636,7 +9638,7 @@ paths: - blob_url - commit_sha - commit_url - - &587 + - &597 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -9691,7 +9693,7 @@ paths: - page_url - commit_sha - commit_url - - &588 + - &598 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -9705,7 +9707,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &589 + - &599 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -9719,7 +9721,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &590 + - &600 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -9733,7 +9735,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &591 + - &601 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -9747,7 +9749,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &592 + - &602 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -9761,7 +9763,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &593 + - &603 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -9775,7 +9777,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &594 + - &604 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -9789,7 +9791,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &595 + - &605 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -9803,7 +9805,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &596 + - &606 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -9817,7 +9819,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &597 + - &607 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -9831,7 +9833,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &598 + - &608 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -9851,7 +9853,7 @@ paths: description: A boolean value representing whether or not the token in the alert was detected in more than one location. examples: - default: &280 + default: &283 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -10203,7 +10205,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &503 + properties: &513 id: type: integer format: int64 @@ -10315,7 +10317,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &439 + properties: &449 url: type: string format: uri @@ -10385,7 +10387,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &440 + required: &450 - closed_issues - creator - description @@ -10464,7 +10466,7 @@ paths: timeline_url: type: string format: uri - type: &196 + type: &199 title: Issue Type description: The type of issue. type: object @@ -10575,7 +10577,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &616 + sub_issues_summary: &626 title: Sub-issues Summary type: object properties: @@ -10589,7 +10591,24 @@ paths: - total - completed - percent_completed - required: &504 + issue_dependencies_summary: &627 + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + required: &514 - assignee - closed_at - comments @@ -10611,7 +10630,7 @@ paths: - author_association - created_at - updated_at - comment: &501 + comment: &511 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11178,7 +11197,7 @@ paths: url: type: string format: uri - user: &628 + user: &639 title: Public User description: Public User type: object @@ -13048,7 +13067,7 @@ paths: - closed - all default: open - - &199 + - &202 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13099,7 +13118,7 @@ paths: type: array items: *77 examples: - default: &200 + default: &203 value: - id: 1 node_id: MDU6SXNzdWUx @@ -14484,14 +14503,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &304 + - &309 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &305 + - &310 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -14562,7 +14581,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &316 + '301': &321 description: Moved permanently content: application/json: @@ -14584,7 +14603,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &533 + - &543 name: all description: If `true`, show notifications marked as read. in: query @@ -14592,7 +14611,7 @@ paths: schema: type: boolean default: false - - &534 + - &544 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14602,7 +14621,7 @@ paths: type: boolean default: false - *67 - - &535 + - &545 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -14634,11 +14653,11 @@ paths: properties: id: type: string - repository: &122 + repository: &125 title: Minimal Repository description: Minimal Repository type: object - properties: &169 + properties: &172 id: type: integer format: int64 @@ -14914,7 +14933,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &241 + security_and_analysis: &244 nullable: true type: object properties: @@ -14988,7 +15007,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &170 + required: &173 - archive_url - assignees_url - blobs_url @@ -15076,7 +15095,7 @@ paths: - url - subscription_url examples: - default: &536 + default: &546 value: - id: '1' repository: @@ -15618,11 +15637,11 @@ paths: application/json: schema: type: array - items: &206 + items: &209 title: Organization Simple description: A GitHub organization. type: object - properties: &153 + properties: &156 login: type: string example: github @@ -15663,7 +15682,7 @@ paths: type: string example: A great organization nullable: true - required: &154 + required: &157 - login - url - id @@ -15677,7 +15696,7 @@ paths: - avatar_url - description examples: - default: &646 + default: &656 value: - login: github id: 1 @@ -15702,6 +15721,643 @@ 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: + - &94 + 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: &336 + 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': *29 + '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: + - *94 + requestBody: + required: true + content: + application/json: + schema: &337 + 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': *29 + '404': *6 + '409': *47 + '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: + - *94 + responses: + '200': + description: Response + content: + application/json: + schema: &95 + 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: &338 + 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: + - *94 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *95 + 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: + - *94 + responses: + '200': + description: Response + content: + application/json: + schema: &339 + 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: &96 + 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': *29 + '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: + - *94 + requestBody: + required: true + content: + application/json: + schema: &340 + 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: *96 + 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: + - *94 + 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': *29 + '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: + - *94 + 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': *29 + '404': *6 + '409': *47 + '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: + - *94 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: *60 + examples: + default: &115 + 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': *29 + '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: + - *94 + 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': *29 + '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: + - *94 + - &97 + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + responses: + '204': + description: No content + '403': *29 + '404': *6 + '409': *47 + '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: + - *94 + - *97 + responses: + '204': + description: No content + '403': *29 + '404': *6 + '409': *47 + '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 @@ -15717,13 +16373,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization parameters: - - &96 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string + - *94 - name: page in: query description: The page number of results to fetch. @@ -15767,8 +16417,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *94 - required: *95 + properties: *98 + required: *99 nullable: true additionalProperties: false examples: @@ -15874,7 +16524,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -15940,7 +16590,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *96 + - *94 requestBody: required: true content: @@ -15987,8 +16637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - *96 - - &672 + - *94 + - &682 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, @@ -15997,7 +16647,7 @@ paths: required: false schema: type: integer - - &673 + - &683 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 @@ -16006,7 +16656,7 @@ paths: required: false schema: type: integer - - &674 + - &684 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 @@ -16015,7 +16665,7 @@ paths: required: false schema: type: integer - - &675 + - &685 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 @@ -16098,7 +16748,7 @@ paths: repositoryName: github/example '400': *14 '403': *29 - '500': *97 + '500': *100 '503': *65 x-github: githubCloudOnly: false @@ -16125,13 +16775,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &98 + schema: &101 title: Organization Full description: Organization Full type: object @@ -16450,7 +17100,7 @@ paths: - updated_at - archived_at examples: - default-response: &99 + default-response: &102 value: login: github id: 1 @@ -16550,7 +17200,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *96 + - *94 requestBody: required: false content: @@ -16766,17 +17416,17 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: *99 + default: *102 '422': description: Validation failed content: application/json: schema: oneOf: - - *100 - - *101 + - *103 + - *104 '409': *47 x-github: githubCloudOnly: false @@ -16800,7 +17450,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *96 + - *94 responses: '202': *39 '404': *6 @@ -16825,7 +17475,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -16872,7 +17522,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -16890,7 +17540,7 @@ paths: type: integer repository_cache_usages: type: array - items: &321 + items: &326 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -16945,7 +17595,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -16963,7 +17613,7 @@ paths: type: integer runners: type: array - items: &102 + items: &105 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -17012,7 +17662,7 @@ paths: - display_name - source nullable: true - machine_size_details: &105 + machine_size_details: &108 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -17104,7 +17754,7 @@ paths: - public_ip_enabled - platform examples: - default: &121 + default: &124 value: total_count: 2 runners: @@ -17164,7 +17814,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -17231,9 +17881,9 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: &106 + default: &109 value: id: 5 name: My hosted ubuntu runner @@ -17272,7 +17922,7 @@ paths: 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: - - *96 + - *94 responses: '200': description: Response @@ -17288,7 +17938,7 @@ paths: type: integer images: type: array - items: &103 + items: &106 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -17324,7 +17974,7 @@ paths: - display_name - source examples: - default: &104 + default: &107 value: id: ubuntu-20.04 platform: linux-x64 @@ -17348,7 +17998,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -17364,9 +18014,9 @@ paths: type: integer images: type: array - items: *103 + items: *106 examples: - default: *104 + default: *107 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17383,7 +18033,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -17436,7 +18086,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -17452,7 +18102,7 @@ paths: type: integer machine_specs: type: array - items: *105 + items: *108 examples: default: value: @@ -17477,7 +18127,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -17521,8 +18171,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *96 - - &107 + - *94 + - &110 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -17534,9 +18184,9 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *106 + default: *109 headers: Link: *58 x-github: @@ -17556,8 +18206,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *96 - - *107 + - *94 + - *110 requestBody: required: true content: @@ -17595,9 +18245,9 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *106 + default: *109 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17613,16 +18263,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *96 - - *107 + - *94 + - *110 responses: '202': description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *106 + default: *109 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -17642,13 +18292,13 @@ paths: 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: - - *96 + - *94 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &108 + schema: &111 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -17662,7 +18312,7 @@ paths: required: - include_claim_keys examples: - default: &109 + default: &112 value: include_claim_keys: - repo @@ -17684,20 +18334,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: application/json: - schema: *108 + schema: *111 examples: - default: *109 + default: *112 responses: '201': description: Empty response content: application/json: - schema: &131 + schema: &134 title: Empty Object description: An object without any properties. type: object @@ -17727,7 +18377,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -17736,7 +18386,7 @@ paths: schema: type: object properties: - enabled_repositories: &110 + enabled_repositories: &113 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -17749,7 +18399,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: &111 + allowed_actions: &114 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -17757,7 +18407,7 @@ paths: - all - local_only - selected - selected_actions_url: &327 + selected_actions_url: &332 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` @@ -17788,7 +18438,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *96 + - *94 responses: '204': description: Response @@ -17799,8 +18449,8 @@ paths: schema: type: object properties: - enabled_repositories: *110 - allowed_actions: *111 + enabled_repositories: *113 + allowed_actions: *114 required: - enabled_repositories examples: @@ -17827,7 +18477,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -17847,127 +18497,7 @@ paths: type: array items: *60 examples: - default: &640 - 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 + default: *115 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17987,7 +18517,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *96 + - *94 responses: '204': description: Response @@ -18031,14 +18561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *96 - - &112 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer + - *94 + - *97 responses: '204': description: Response @@ -18060,8 +18584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *96 - - *112 + - *94 + - *97 responses: '204': description: Response @@ -18084,13 +18608,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &113 + schema: &116 type: object properties: github_owned_allowed: @@ -18112,7 +18636,7 @@ paths: items: type: string examples: - default: &114 + default: &117 value: github_owned_allowed: true verified_allowed: false @@ -18137,7 +18661,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *96 + - *94 responses: '204': description: Response @@ -18145,9 +18669,9 @@ paths: required: false content: application/json: - schema: *113 + schema: *116 examples: - selected_actions: *114 + selected_actions: *117 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18169,23 +18693,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &331 + schema: &341 type: object properties: - default_workflow_permissions: &115 + default_workflow_permissions: &118 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &116 + can_approve_pull_request_reviews: &119 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -18193,7 +18717,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &117 + default: &120 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -18218,7 +18742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *96 + - *94 responses: '204': description: Success response @@ -18226,13 +18750,13 @@ paths: required: false content: application/json: - schema: &332 + schema: &342 type: object properties: - default_workflow_permissions: *115 - can_approve_pull_request_reviews: *116 + default_workflow_permissions: *118 + can_approve_pull_request_reviews: *119 examples: - default: *117 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18252,7 +18776,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *96 + - *94 - *17 - *19 - name: visible_to_repository @@ -18277,7 +18801,7 @@ paths: type: number runner_groups: type: array - items: &118 + items: &121 type: object properties: id: @@ -18393,7 +18917,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -18465,9 +18989,9 @@ paths: description: Response content: application/json: - schema: *118 + schema: *121 examples: - default: &120 + default: &123 value: id: 2 name: octo-runner-group @@ -18502,8 +19026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *96 - - &119 + - *94 + - &122 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -18515,7 +19039,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *121 examples: default: value: @@ -18551,8 +19075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *96 - - *119 + - *94 + - *122 requestBody: required: true content: @@ -18606,9 +19130,9 @@ paths: description: Response content: application/json: - schema: *118 + schema: *121 examples: - default: *120 + default: *123 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18627,8 +19151,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *96 - - *119 + - *94 + - *122 responses: '204': description: Response @@ -18651,8 +19175,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *96 - - *119 + - *94 + - *122 - *17 - *19 responses: @@ -18670,9 +19194,9 @@ paths: type: number runners: type: array - items: *102 + items: *105 examples: - default: *121 + default: *124 headers: Link: *58 x-github: @@ -18694,8 +19218,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *96 - - *119 + - *94 + - *122 - *19 - *17 responses: @@ -18713,9 +19237,9 @@ paths: type: number repositories: type: array - items: *122 + items: *125 examples: - default: &631 + default: &642 value: total_count: 1 repositories: @@ -18967,8 +19491,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *96 - - *119 + - *94 + - *122 requestBody: required: true content: @@ -19012,9 +19536,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *96 - - *119 - - *112 + - *94 + - *122 + - *97 responses: '204': description: Response @@ -19036,9 +19560,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *96 - - *119 - - *112 + - *94 + - *122 + - *97 responses: '204': description: Response @@ -19061,8 +19585,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *96 - - *119 + - *94 + - *122 - *17 - *19 responses: @@ -19080,7 +19604,7 @@ paths: type: number runners: type: array - items: &124 + items: &127 title: Self hosted runners description: A self hosted runner type: object @@ -19109,7 +19633,7 @@ paths: type: boolean labels: type: array - items: &127 + items: &130 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -19139,7 +19663,7 @@ paths: - busy - labels examples: - default: &125 + default: &128 value: total_count: 2 runners: @@ -19198,8 +19722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *96 - - *119 + - *94 + - *122 requestBody: required: true content: @@ -19243,9 +19767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *96 - - *119 - - &123 + - *94 + - *122 + - &126 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -19273,9 +19797,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *96 - - *119 - - *123 + - *94 + - *122 + - *126 responses: '204': description: Response @@ -19305,7 +19829,7 @@ paths: in: query schema: type: string - - *96 + - *94 - *17 - *19 responses: @@ -19323,9 +19847,9 @@ paths: type: integer runners: type: array - items: *124 + items: *127 examples: - default: *125 + default: *128 headers: Link: *58 x-github: @@ -19349,7 +19873,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -19357,7 +19881,7 @@ paths: application/json: schema: type: array - items: &333 + items: &343 title: Runner Application description: Runner Application type: object @@ -19382,7 +19906,7 @@ paths: - download_url - filename examples: - default: &334 + default: &344 value: - os: osx architecture: x64 @@ -19425,7 +19949,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -19468,7 +19992,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &335 + '201': &345 description: Response content: application/json: @@ -19478,7 +20002,7 @@ paths: - runner - encoded_jit_config properties: - runner: *124 + runner: *127 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -19535,13 +20059,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *96 + - *94 responses: '201': description: Response content: application/json: - schema: &126 + schema: &129 title: Authentication Token description: Authentication Token type: object @@ -19579,7 +20103,7 @@ paths: - token - expires_at examples: - default: &336 + default: &346 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -19610,15 +20134,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *96 + - *94 responses: '201': description: Response content: application/json: - schema: *126 + schema: *129 examples: - default: &337 + default: &347 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -19643,16 +20167,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 + - *94 + - *126 responses: '200': description: Response content: application/json: - schema: *124 + schema: *127 examples: - default: &338 + default: &348 value: id: 23 name: MBP @@ -19693,8 +20217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *96 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -19720,10 +20244,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 + - *94 + - *126 responses: - '200': &128 + '200': &131 description: Response content: application/json: @@ -19737,7 +20261,7 @@ paths: type: integer labels: type: array - items: *127 + items: *130 examples: default: value: @@ -19776,8 +20300,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 + - *94 + - *126 requestBody: required: true content: @@ -19801,7 +20325,7 @@ paths: - gpu - accelerated responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -19825,8 +20349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 + - *94 + - *126 requestBody: required: true content: @@ -19851,7 +20375,7 @@ paths: - gpu - accelerated responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -19875,10 +20399,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 + - *94 + - *126 responses: - '200': &339 + '200': &349 description: Response content: application/json: @@ -19892,7 +20416,7 @@ paths: type: integer labels: type: array - items: *127 + items: *130 examples: default: value: @@ -19933,9 +20457,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *96 - - *123 - - &340 + - *94 + - *126 + - &350 name: name description: The name of a self-hosted runner's custom label. in: path @@ -19943,7 +20467,7 @@ paths: schema: type: string responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -19968,7 +20492,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *96 + - *94 - *17 - *19 responses: @@ -19986,7 +20510,7 @@ paths: type: integer secrets: type: array - items: &129 + items: &132 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -20059,13 +20583,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &352 + schema: &362 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -20094,7 +20618,7 @@ paths: - key_id - key examples: - default: &353 + default: &363 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -20119,8 +20643,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *96 - - &130 + - *94 + - &133 name: secret_name description: The name of the secret. in: path @@ -20132,7 +20656,7 @@ paths: description: Response content: application/json: - schema: *129 + schema: *132 examples: default: value: @@ -20162,8 +20686,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -20220,7 +20744,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -20246,8 +20770,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 responses: '204': description: Response @@ -20273,8 +20797,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - *19 - *17 responses: @@ -20292,9 +20816,9 @@ paths: type: integer repositories: type: array - items: *122 + items: *125 examples: - default: &134 + default: &137 value: total_count: 1 repositories: @@ -20386,8 +20910,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -20439,8 +20963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -20473,8 +20997,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -20506,8 +21030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *96 - - &326 + - *94 + - &331 name: per_page description: The number of results per page (max 30). 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)." @@ -20531,7 +21055,7 @@ paths: type: integer variables: type: array - items: &132 + items: &135 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -20616,7 +21140,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *96 + - *94 requestBody: required: true content: @@ -20664,7 +21188,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -20689,8 +21213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *96 - - &133 + - *94 + - &136 name: name description: The name of the variable. in: path @@ -20702,7 +21226,7 @@ paths: description: Response content: application/json: - schema: *132 + schema: *135 examples: default: value: @@ -20732,8 +21256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 requestBody: required: true content: @@ -20795,8 +21319,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 responses: '204': description: Response @@ -20822,8 +21346,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 - *19 - *17 responses: @@ -20841,9 +21365,9 @@ paths: type: integer repositories: type: array - items: *122 + items: *125 examples: - default: *134 + default: *137 '409': description: Response when the visibility of the variable is not set to `selected` @@ -20869,8 +21393,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 requestBody: required: true content: @@ -20919,8 +21443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 - name: repository_id in: path required: true @@ -20954,8 +21478,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *96 - - *133 + - *94 + - *136 - name: repository_id in: path required: true @@ -20991,7 +21515,7 @@ paths: - *17 - *40 - *41 - - *96 + - *94 requestBody: required: true content: @@ -21014,12 +21538,12 @@ paths: required: - subject_digests examples: - default: &661 + default: &671 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &662 + withPredicateType: &672 value: subject_digests: - sha256:abc123 @@ -21077,7 +21601,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &663 + default: &673 value: attestations_subject_digests: - sha256:abc: @@ -21186,7 +21710,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *96 + - *94 requestBody: required: true content: @@ -21251,7 +21775,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *96 + - *94 - name: subject_digest description: Subject Digest in: path @@ -21282,7 +21806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *96 + - *94 - name: attestation_id description: Attestation ID in: path @@ -21320,7 +21844,7 @@ paths: - *17 - *40 - *41 - - *96 + - *94 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -21371,7 +21895,7 @@ paths: bundle_url: type: string examples: - default: &366 + default: &376 value: attestations: - bundle: @@ -21478,7 +22002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -21490,7 +22014,7 @@ paths: type: array items: *4 examples: - default: &201 + default: &204 value: - login: octocat id: 1 @@ -21528,8 +22052,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *96 - - &135 + - *94 + - &138 name: username description: The handle for the GitHub user account. in: path @@ -21560,8 +22084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -21581,8 +22105,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -21607,7 +22131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *96 + - *94 - *19 - *17 - *48 @@ -21615,7 +22139,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &136 + schema: &139 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -21641,7 +22165,7 @@ paths: application/json: schema: type: array - items: &137 + items: &140 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -21672,7 +22196,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &155 + items: &158 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -21731,7 +22255,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &214 + properties: &217 id: description: Unique identifier of the team type: integer @@ -21787,7 +22311,7 @@ paths: to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &215 + required: &218 - id - node_id - url @@ -21828,7 +22352,7 @@ paths: type: string format: date-time nullable: true - state: *136 + state: *139 contact_link: description: The contact link of the campaign. type: string @@ -21949,7 +22473,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -22043,9 +22567,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *140 examples: - default: &138 + default: &141 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -22116,7 +22640,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *96 + - *94 - name: campaign_number description: The campaign number. in: path @@ -22128,9 +22652,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *140 examples: - default: *138 + default: *141 '404': *6 '422': description: Unprocessable Entity @@ -22158,7 +22682,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *96 + - *94 - name: campaign_number description: The campaign number. in: path @@ -22207,7 +22731,7 @@ paths: type: string format: uri nullable: true - state: *136 + state: *139 examples: default: value: @@ -22217,9 +22741,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *140 examples: - default: *138 + default: *141 '400': description: Bad Request content: @@ -22252,7 +22776,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *96 + - *94 - name: campaign_number description: The campaign number. in: path @@ -22285,18 +22809,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *96 - - &392 + - *94 + - &402 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false - schema: &142 + schema: &145 type: string description: The name of the tool used to generate the code scanning analysis. - - &393 + - &403 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -22304,7 +22828,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &143 + schema: &146 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -22319,7 +22843,7 @@ paths: be returned. in: query required: false - schema: &395 + schema: &405 type: string description: State of a code scanning alert. enum: @@ -22342,7 +22866,7 @@ paths: be returned. in: query required: false - schema: &396 + schema: &406 type: string description: Severity of a code scanning alert. enum: @@ -22365,16 +22889,16 @@ paths: properties: number: *54 created_at: *55 - updated_at: *139 + updated_at: *142 url: *56 html_url: *57 - instances_url: &397 + instances_url: &407 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &144 + state: &147 type: string description: State of a code scanning alert. nullable: true @@ -22382,7 +22906,7 @@ paths: - open - dismissed - fixed - fixed_at: *140 + fixed_at: *143 dismissed_by: title: Simple User description: A GitHub user. @@ -22390,8 +22914,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *141 - dismissed_reason: &398 + dismissed_at: *144 + dismissed_reason: &408 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -22400,13 +22924,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &399 + dismissed_comment: &409 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &400 + rule: &410 type: object properties: id: @@ -22459,25 +22983,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &401 + tool: &411 type: object properties: - name: *142 + name: *145 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *143 - most_recent_instance: &402 + guid: *146 + most_recent_instance: &412 type: object properties: - ref: &394 + ref: &404 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &412 + analysis_key: &422 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -22488,13 +23012,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &413 + category: &423 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *144 + state: *147 commit_sha: type: string message: @@ -22809,7 +23333,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *96 + - *94 - name: target_type in: query description: The target type of the code security configuration @@ -22920,7 +23444,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *96 + - *94 requestBody: required: true content: @@ -22998,7 +23522,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *145 + code_scanning_options: *148 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -23141,7 +23665,7 @@ paths: application/json: schema: *43 examples: - default: *146 + default: *149 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23163,15 +23687,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: *147 + schema: *150 examples: - default: *148 + default: *151 '304': *37 '403': *29 '404': *6 @@ -23197,7 +23721,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *96 + - *94 requestBody: required: true content: @@ -23223,7 +23747,7 @@ paths: - 32 - 91 responses: - '204': *149 + '204': *152 '400': *14 '403': *29 '404': *6 @@ -23249,7 +23773,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *96 + - *94 - *45 responses: '200': @@ -23258,7 +23782,7 @@ paths: application/json: schema: *43 examples: - default: *146 + default: *149 '304': *37 '403': *29 '404': *6 @@ -23282,7 +23806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *96 + - *94 - *45 requestBody: required: true @@ -23539,10 +24063,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *96 + - *94 - *45 responses: - '204': *149 + '204': *152 '400': *14 '403': *29 '404': *6 @@ -23570,7 +24094,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *96 + - *94 - *45 requestBody: required: true @@ -23634,7 +24158,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *96 + - *94 - *45 requestBody: required: true @@ -23680,7 +24204,7 @@ paths: default: value: default_for_new_repos: all - configuration: *146 + configuration: *149 '403': *29 '404': *6 x-github: @@ -23704,7 +24228,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *96 + - *94 - *45 - name: per_page description: The number of results per page (max 100). For more information, @@ -23733,13 +24257,13 @@ paths: application/json: schema: type: array - items: *150 + items: *153 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *151 + repository: *154 '403': *29 '404': *6 x-github: @@ -23763,7 +24287,7 @@ paths: parameters: - *17 - *19 - - *96 + - *94 responses: '200': description: Response @@ -23779,7 +24303,7 @@ paths: type: integer codespaces: type: array - items: &202 + items: &205 type: object title: Codespace description: A codespace. @@ -23804,12 +24328,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *122 + repository: *125 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &425 + properties: &435 name: type: string description: The name of the machine. @@ -23851,7 +24375,7 @@ paths: - ready - in_progress nullable: true - required: &426 + required: &436 - name - display_name - operating_system @@ -24056,7 +24580,7 @@ paths: - pulls_url - recent_folders examples: - default: &203 + default: &206 value: total_count: 3 codespaces: @@ -24466,7 +24990,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -24488,7 +25012,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *96 + - *94 deprecated: true requestBody: required: true @@ -24532,7 +25056,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24555,7 +25079,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *96 + - *94 deprecated: true requestBody: required: true @@ -24587,7 +25111,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24610,7 +25134,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *96 + - *94 requestBody: required: true content: @@ -24641,7 +25165,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -24662,7 +25186,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *96 + - *94 - *17 - *19 responses: @@ -24680,7 +25204,7 @@ paths: type: integer secrets: type: array - items: &152 + items: &155 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -24719,7 +25243,7 @@ paths: - updated_at - visibility examples: - default: &427 + default: &437 value: total_count: 2 secrets: @@ -24751,13 +25275,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &428 + schema: &438 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -24786,7 +25310,7 @@ paths: - key_id - key examples: - default: &429 + default: &439 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24809,16 +25333,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 responses: '200': description: Response content: application/json: - schema: *152 + schema: *155 examples: - default: &431 + default: &441 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -24845,8 +25369,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -24901,7 +25425,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -24927,8 +25451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 responses: '204': description: Response @@ -24953,8 +25477,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - *19 - *17 responses: @@ -24972,9 +25496,9 @@ paths: type: integer repositories: type: array - items: *122 + items: *125 examples: - default: *134 + default: *137 '404': *6 x-github: githubCloudOnly: false @@ -24996,8 +25520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -25047,8 +25571,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -25081,8 +25605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -25121,7 +25645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *96 + - *94 responses: '200': description: OK @@ -25230,7 +25754,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25252,7 +25776,7 @@ paths: Only organization owners can view assigned seats. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -25262,7 +25786,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *96 + - *94 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -25285,7 +25809,7 @@ paths: currently being billed. seats: type: array - items: &205 + items: &208 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -25302,14 +25826,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *153 - required: *154 + properties: *156 + required: *157 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *155 + - *158 - title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -25477,7 +26001,7 @@ paths: site_admin: false headers: Link: *58 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25510,7 +26034,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *96 + - *94 requestBody: content: application/json: @@ -25552,7 +26076,7 @@ paths: default: value: seats_created: 5 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25588,7 +26112,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *96 + - *94 requestBody: content: application/json: @@ -25630,7 +26154,7 @@ paths: default: value: seats_cancelled: 5 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25668,7 +26192,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *96 + - *94 requestBody: content: application/json: @@ -25709,7 +26233,7 @@ paths: default: value: seats_created: 5 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25745,7 +26269,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *96 + - *94 requestBody: content: application/json: @@ -25787,7 +26311,7 @@ paths: default: value: seats_cancelled: 5 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -25826,7 +26350,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *96 + - *94 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -25858,7 +26382,7 @@ paths: application/json: schema: type: array - items: &286 + items: &291 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -26165,7 +26689,7 @@ paths: - date additionalProperties: true examples: - default: &287 + default: &292 value: - date: '2024-06-24' total_active_users: 24 @@ -26264,10 +26788,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *97 + '500': *100 '403': *29 '404': *6 - '422': &288 + '422': &293 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -26294,20 +26818,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *96 - - *156 - - *157 - - *158 + - *94 - *159 - *160 - *161 - *162 - *163 + - *164 + - *165 + - *166 - *48 - *40 - *41 - - *164 - - *165 + - *167 + - *168 - *17 responses: '200': @@ -26316,9 +26840,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *167 + default: *170 '304': *37 '400': *14 '403': *29 @@ -26344,7 +26868,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *96 + - *94 - *17 - *19 responses: @@ -26362,7 +26886,7 @@ paths: type: integer secrets: type: array - items: &168 + items: &171 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -26433,13 +26957,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &458 + schema: &468 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -26456,7 +26980,7 @@ paths: - key_id - key examples: - default: &459 + default: &469 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -26479,14 +27003,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 responses: '200': description: Response content: application/json: - schema: *168 + schema: *171 examples: default: value: @@ -26514,8 +27038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -26570,7 +27094,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -26594,8 +27118,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 responses: '204': description: Response @@ -26619,8 +27143,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - *19 - *17 responses: @@ -26638,9 +27162,9 @@ paths: type: integer repositories: type: array - items: *122 + items: *125 examples: - default: *134 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26661,8 +27185,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -26712,8 +27236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -26744,8 +27268,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *96 - - *130 + - *94 + - *133 - name: repository_id in: path required: true @@ -26775,7 +27299,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -26783,7 +27307,7 @@ paths: application/json: schema: type: array - items: &217 + items: &220 title: Package description: A software package type: object @@ -26833,8 +27357,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *169 - required: *170 + properties: *172 + required: *173 nullable: true created_at: type: string @@ -26853,7 +27377,7 @@ paths: - created_at - updated_at examples: - default: &218 + default: &221 value: - id: 197 name: hello_docker @@ -26931,7 +27455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *96 + - *94 - *17 - *19 responses: @@ -27010,7 +27534,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *96 + - *94 - *17 - *19 responses: @@ -27020,7 +27544,7 @@ paths: application/json: schema: type: array - items: &193 + items: &196 title: Organization Invitation description: Organization Invitation type: object @@ -27067,7 +27591,7 @@ paths: - invitation_teams_url - node_id examples: - default: &194 + default: &197 value: - id: 1 login: monalisa @@ -27124,7 +27648,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *96 + - *94 - *17 - *19 responses: @@ -27134,7 +27658,7 @@ paths: application/json: schema: type: array - items: &171 + items: &174 title: Org Hook description: Org Hook type: object @@ -27245,7 +27769,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *96 + - *94 requestBody: required: true content: @@ -27305,9 +27829,9 @@ paths: description: Response content: application/json: - schema: *171 + schema: *174 examples: - default: &172 + default: &175 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -27354,8 +27878,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *96 - - &173 + - *94 + - &176 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. @@ -27368,9 +27892,9 @@ paths: description: Response content: application/json: - schema: *171 + schema: *174 examples: - default: *172 + default: *175 '404': *6 x-github: githubCloudOnly: false @@ -27397,8 +27921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 requestBody: required: false content: @@ -27443,7 +27967,7 @@ paths: description: Response content: application/json: - schema: *171 + schema: *174 examples: default: value: @@ -27484,8 +28008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 responses: '204': description: Response @@ -27512,8 +28036,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *96 - - *173 + - *94 + - *176 responses: '200': description: Response @@ -27543,8 +28067,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *96 - - *173 + - *94 + - *176 requestBody: required: false content: @@ -27594,10 +28118,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 - *17 - - *174 + - *177 responses: '200': description: Response @@ -27605,9 +28129,9 @@ paths: application/json: schema: type: array - items: *175 + items: *178 examples: - default: *176 + default: *179 '400': *14 '422': *15 x-github: @@ -27632,17 +28156,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 - *16 responses: '200': description: Response content: application/json: - schema: *177 + schema: *180 examples: - default: *178 + default: *181 '400': *14 '422': *15 x-github: @@ -27667,8 +28191,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 - *16 responses: '202': *39 @@ -27697,8 +28221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *96 - - *173 + - *94 + - *176 responses: '204': description: Response @@ -27720,8 +28244,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *96 - - &183 + - *94 + - &186 name: actor_type in: path description: The type of the actor @@ -27734,14 +28258,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &184 + - &187 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &179 + - &182 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -27749,7 +28273,7 @@ paths: required: true schema: type: string - - &180 + - &183 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -27842,13 +28366,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *96 - - *179 - - *180 + - *94 + - *182 + - *183 - *19 - *17 - *48 - - &189 + - &192 name: sort description: The property to sort the results by. in: query @@ -27926,15 +28450,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *96 - - *179 - - *180 + - *94 + - *182 + - *183 responses: '200': description: Response content: application/json: - schema: &181 + schema: &184 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -27950,7 +28474,7 @@ paths: type: integer format: int64 examples: - default: &182 + default: &185 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -27970,24 +28494,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *96 - - &185 + - *94 + - &188 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *179 - - *180 + - *182 + - *183 responses: '200': description: Response content: application/json: - schema: *181 + schema: *184 examples: - default: *182 + default: *185 x-github: enabledForGitHubApps: true category: orgs @@ -28005,19 +28529,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *96 - - *179 - - *180 + - *94 + - *182 - *183 - - *184 + - *186 + - *187 responses: '200': description: Response content: application/json: - schema: *181 + schema: *184 examples: - default: *182 + default: *185 x-github: enabledForGitHubApps: true category: orgs @@ -28034,10 +28558,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *96 - - *179 - - *180 - - &186 + - *94 + - *182 + - *183 + - &189 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -28050,7 +28574,7 @@ paths: description: Response content: application/json: - schema: &187 + schema: &190 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -28066,7 +28590,7 @@ paths: type: integer format: int64 examples: - default: &188 + default: &191 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -28102,19 +28626,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *96 - - *185 - - *179 - - *180 - - *186 + - *94 + - *188 + - *182 + - *183 + - *189 responses: '200': description: Response content: application/json: - schema: *187 + schema: *190 examples: - default: *188 + default: *191 x-github: enabledForGitHubApps: true category: orgs @@ -28131,20 +28655,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *96 - - *183 - - *184 - - *179 - - *180 + - *94 - *186 + - *187 + - *182 + - *183 + - *189 responses: '200': description: Response content: application/json: - schema: *187 + schema: *190 examples: - default: *188 + default: *191 x-github: enabledForGitHubApps: true category: orgs @@ -28161,14 +28685,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *96 - - *185 - - *179 - - *180 + - *94 + - *188 + - *182 + - *183 - *19 - *17 - *48 - - *189 + - *192 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -28241,7 +28765,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *96 + - *94 responses: '200': description: Response @@ -28249,7 +28773,7 @@ paths: application/json: schema: *22 examples: - default: &497 + default: &507 value: id: 1 account: @@ -28318,7 +28842,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -28407,7 +28931,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -28415,12 +28939,12 @@ paths: application/json: schema: anyOf: - - &191 + - &194 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &190 + limit: &193 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -28445,7 +28969,7 @@ paths: properties: {} additionalProperties: false examples: - default: &192 + default: &195 value: limit: collaborators_only origin: organization @@ -28469,18 +28993,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: application/json: - schema: &498 + schema: &508 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *190 + limit: *193 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -28504,9 +29028,9 @@ paths: description: Response content: application/json: - schema: *191 + schema: *194 examples: - default: *192 + default: *195 '422': *15 x-github: githubCloudOnly: false @@ -28524,7 +29048,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *96 + - *94 responses: '204': description: Response @@ -28548,7 +29072,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *96 + - *94 - *17 - *19 - name: role @@ -28582,9 +29106,9 @@ paths: application/json: schema: type: array - items: *193 + items: *196 examples: - default: *194 + default: *197 headers: Link: *58 '404': *6 @@ -28607,7 +29131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *96 + - *94 requestBody: required: false content: @@ -28661,7 +29185,7 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: default: value: @@ -28715,8 +29239,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *96 - - &195 + - *94 + - &198 name: invitation_id description: The unique identifier of the invitation. in: path @@ -28746,8 +29270,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *96 - - *195 + - *94 + - *198 - *17 - *19 responses: @@ -28757,9 +29281,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: &216 + default: &219 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -28794,7 +29318,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -28802,7 +29326,7 @@ paths: application/json: schema: type: array - items: *196 + items: *199 examples: default: value: @@ -28840,7 +29364,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -28887,9 +29411,9 @@ paths: description: Response content: application/json: - schema: *196 + schema: *199 examples: - default: &197 + default: &200 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -28921,8 +29445,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *96 - - &198 + - *94 + - &201 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -28975,9 +29499,9 @@ paths: description: Response content: application/json: - schema: *196 + schema: *199 examples: - default: *197 + default: *200 '404': *6 '422': *7 x-github: @@ -29001,8 +29525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *96 - - *198 + - *94 + - *201 responses: '204': description: Response @@ -29035,7 +29559,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *96 + - *94 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -29065,7 +29589,7 @@ paths: - closed - all default: open - - *199 + - *202 - name: type description: Can be the name of an issue type. in: query @@ -29096,7 +29620,7 @@ paths: type: array items: *77 examples: - default: *200 + default: *203 headers: Link: *58 '404': *6 @@ -29118,7 +29642,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *96 + - *94 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -29156,7 +29680,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '422': *15 @@ -29176,8 +29700,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response if requester is an organization member and user is @@ -29211,8 +29735,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -29238,8 +29762,8 @@ paths: parameters: - *17 - *19 - - *96 - - *135 + - *94 + - *138 responses: '200': description: Response @@ -29255,11 +29779,11 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: - default: *203 + default: *206 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -29282,9 +29806,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *96 - - *135 - - &204 + - *94 + - *138 + - &207 name: codespace_name in: path required: true @@ -29294,7 +29818,7 @@ paths: responses: '202': *39 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -29317,17 +29841,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *96 - - *135 - - *204 + - *94 + - *138 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: &424 + default: &434 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -29469,7 +29993,7 @@ paths: recent_folders: [] template: '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -29488,7 +30012,7 @@ paths: Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -29500,14 +30024,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *205 + schema: *208 examples: default: value: @@ -29550,7 +30074,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -29575,14 +30099,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '200': description: Response content: application/json: - schema: &207 + schema: &210 title: Org Membership description: Org Membership type: object @@ -29626,7 +30150,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *206 + organization: *209 user: title: Simple User description: A GitHub user. @@ -29649,7 +30173,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &208 + response-if-user-has-an-active-admin-membership-with-organization: &211 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -29717,8 +30241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 requestBody: required: false content: @@ -29746,9 +30270,9 @@ paths: description: Response content: application/json: - schema: *207 + schema: *210 examples: - response-if-user-already-had-membership-with-organization: *208 + response-if-user-already-had-membership-with-organization: *211 '422': *15 '403': *29 x-github: @@ -29772,8 +30296,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -29798,7 +30322,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *96 + - *94 - *17 - *19 - name: exclude @@ -29819,7 +30343,7 @@ paths: application/json: schema: type: array - items: &209 + items: &212 title: Migration description: A migration. type: object @@ -30072,7 +30596,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *96 + - *94 requestBody: required: true content: @@ -30148,7 +30672,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -30326,8 +30850,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *96 - - &210 + - *94 + - &213 name: migration_id description: The unique identifier of the migration. in: path @@ -30354,7 +30878,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -30523,8 +31047,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *96 - - *210 + - *94 + - *213 responses: '302': description: Response @@ -30545,8 +31069,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *96 - - *210 + - *94 + - *213 responses: '204': description: Response @@ -30569,9 +31093,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *96 - - *210 - - &645 + - *94 + - *213 + - &655 name: repo_name description: repo_name parameter in: path @@ -30598,8 +31122,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *96 - - *210 + - *94 + - *213 - *17 - *19 responses: @@ -30609,9 +31133,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: &223 + default: &226 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -30748,7 +31272,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response - list of organization roles @@ -30764,7 +31288,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &213 + items: &216 title: Organization Role description: Organization roles type: object @@ -30911,8 +31435,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *96 - - &211 + - *94 + - &214 name: team_slug description: The slug of the team name. in: path @@ -30943,9 +31467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *96 - - *211 - - &212 + - *94 + - *214 + - &215 name: role_id description: The unique identifier of the role. in: path @@ -30980,9 +31504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *96 - - *211 - - *212 + - *94 + - *214 + - *215 responses: '204': description: Response @@ -31007,8 +31531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -31033,9 +31557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *96 - - *135 - - *212 + - *94 + - *138 + - *215 responses: '204': description: Response @@ -31065,9 +31589,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *96 - - *135 - - *212 + - *94 + - *138 + - *215 responses: '204': description: Response @@ -31095,14 +31619,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *96 - - *212 + - *94 + - *215 responses: '200': description: Response content: application/json: - schema: *213 + schema: *216 examples: default: value: @@ -31152,8 +31676,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *96 - - *212 + - *94 + - *215 - *17 - *19 responses: @@ -31231,8 +31755,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *214 - required: *215 + properties: *217 + required: *218 nullable: true required: - id @@ -31247,7 +31771,7 @@ paths: - slug - parent examples: - default: *216 + default: *219 headers: Link: *58 '404': @@ -31276,8 +31800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *96 - - *212 + - *94 + - *215 - *17 - *19 responses: @@ -31305,13 +31829,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &282 + items: &287 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *214 - required: *215 + properties: *217 + required: *218 name: nullable: true type: string @@ -31406,7 +31930,7 @@ paths: - type - url examples: - default: *201 + default: *204 headers: Link: *58 '404': @@ -31430,7 +31954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *96 + - *94 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -31457,7 +31981,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -31482,8 +32006,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *96 - - *135 + - *94 + - *138 requestBody: required: false content: @@ -31540,8 +32064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -31598,8 +32122,8 @@ paths: - docker - nuget - container - - *96 - - &647 + - *94 + - &657 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -31635,12 +32159,12 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: *218 + default: *221 '403': *29 '401': *25 - '400': &649 + '400': &659 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -31662,7 +32186,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &219 + - &222 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -31680,20 +32204,20 @@ paths: - docker - nuget - container - - &220 + - &223 name: package_name description: The name of the package. in: path required: true schema: type: string - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: default: value: @@ -31745,9 +32269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *219 - - *220 - - *96 + - *222 + - *223 + - *94 responses: '204': description: Response @@ -31779,9 +32303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *219 - - *220 - - *96 + - *222 + - *223 + - *94 - name: token description: package token schema: @@ -31813,9 +32337,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *219 - - *220 - - *96 + - *222 + - *223 + - *94 - *19 - *17 - name: state @@ -31835,7 +32359,7 @@ paths: application/json: schema: type: array - items: &221 + items: &224 title: Package Version description: A version of a software package type: object @@ -31960,10 +32484,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *219 - - *220 - - *96 - - &222 + - *222 + - *223 + - *94 + - &225 name: package_version_id description: Unique identifier of the package version. in: path @@ -31975,7 +32499,7 @@ paths: description: Response content: application/json: - schema: *221 + schema: *224 examples: default: value: @@ -32011,10 +32535,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *219 - - *220 - - *96 - *222 + - *223 + - *94 + - *225 responses: '204': description: Response @@ -32046,10 +32570,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *219 - - *220 - - *96 - *222 + - *223 + - *94 + - *225 responses: '204': description: Response @@ -32076,10 +32600,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *96 + - *94 - *17 - *19 - - &224 + - &227 name: sort description: The property by which to sort the results. in: query @@ -32090,7 +32614,7 @@ paths: - created_at default: created_at - *48 - - &225 + - &228 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -32101,7 +32625,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &226 + - &229 name: repository description: The name of the repository to use to filter the results. in: query @@ -32109,7 +32633,7 @@ paths: schema: type: string example: Hello-World - - &227 + - &230 name: permission description: The permission to use to filter the results. in: query @@ -32117,7 +32641,7 @@ paths: schema: type: string example: issues_read - - &228 + - &231 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -32127,7 +32651,7 @@ paths: schema: type: string format: date-time - - &229 + - &232 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -32137,7 +32661,7 @@ paths: schema: type: string format: date-time - - &230 + - &233 name: token_id description: The ID of the token in: query @@ -32149,7 +32673,7 @@ paths: type: string example: token_id[]=1,token_id[]=2 responses: - '500': *97 + '500': *100 '422': *15 '404': *6 '403': *29 @@ -32301,7 +32825,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *96 + - *94 requestBody: required: true content: @@ -32342,7 +32866,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *97 + '500': *100 '422': *15 '404': *6 '403': *29 @@ -32367,7 +32891,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *96 + - *94 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -32403,11 +32927,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *97 + '500': *100 '422': *15 '404': *6 '403': *29 - '204': *149 + '204': *152 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32428,7 +32952,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *96 + - *94 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -32439,7 +32963,7 @@ paths: - *17 - *19 responses: - '500': *97 + '500': *100 '404': *6 '403': *29 '200': @@ -32448,9 +32972,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -32473,19 +32997,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *96 + - *94 - *17 - *19 - - *224 - - *48 - - *225 - - *226 - *227 + - *48 - *228 - *229 - *230 + - *231 + - *232 + - *233 responses: - '500': *97 + '500': *100 '422': *15 '404': *6 '403': *29 @@ -32632,7 +33156,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *96 + - *94 requestBody: required: true content: @@ -32667,7 +33191,7 @@ paths: - 1296269 - 1296280 responses: - '500': *97 + '500': *100 '404': *6 '202': *39 '403': *29 @@ -32692,7 +33216,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *96 + - *94 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -32720,9 +33244,9 @@ paths: value: action: revoke responses: - '500': *97 + '500': *100 '404': *6 - '204': *149 + '204': *152 '403': *29 '422': *15 x-github: @@ -32744,7 +33268,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *96 + - *94 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -32754,7 +33278,7 @@ paths: - *17 - *19 responses: - '500': *97 + '500': *100 '404': *6 '403': *29 '200': @@ -32763,9 +33287,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -32789,7 +33313,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -32807,7 +33331,7 @@ paths: type: integer configurations: type: array - items: &231 + items: &234 title: Organization private registry description: Private registry configuration for an organization type: object @@ -32895,7 +33419,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -33060,7 +33584,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &232 + org-private-registry-with-selected-visibility: &235 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -33101,7 +33625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -33149,16 +33673,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *96 - - *130 + - *94 + - *133 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *231 + schema: *234 examples: - default: *232 + default: *235 '404': *6 x-github: githubCloudOnly: false @@ -33179,8 +33703,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *96 - - *130 + - *94 + - *133 requestBody: required: true content: @@ -33275,8 +33799,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *96 - - *130 + - *94 + - *133 responses: '204': description: Response @@ -33301,7 +33825,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-organization-projects parameters: - - *96 + - *94 - name: state description: Indicates the state of the projects to return. in: query @@ -33322,7 +33846,7 @@ paths: application/json: schema: type: array - items: &233 + items: &236 title: Project description: Projects are a way to organize columns and cards of work. @@ -33469,7 +33993,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-an-organization-project parameters: - - *96 + - *94 requestBody: required: true content: @@ -33495,7 +34019,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: default: value: @@ -33533,7 +34057,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': &313 + '410': &318 description: Gone content: application/json: @@ -33560,7 +34084,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response @@ -33568,7 +34092,7 @@ paths: application/json: schema: type: array - items: &234 + items: &237 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -33634,7 +34158,7 @@ paths: - property_name - value_type examples: - default: &235 + default: &238 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -33682,7 +34206,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -33693,7 +34217,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *234 + items: *237 minItems: 1 maxItems: 100 required: @@ -33723,9 +34247,9 @@ paths: application/json: schema: type: array - items: *234 + items: *237 examples: - default: *235 + default: *238 '403': *29 '404': *6 x-github: @@ -33746,8 +34270,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *96 - - &236 + - *94 + - &239 name: custom_property_name description: The custom property name in: path @@ -33759,9 +34283,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *237 examples: - default: &237 + default: &240 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -33795,8 +34319,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *96 - - *236 + - *94 + - *239 requestBody: required: true content: @@ -33865,9 +34389,9 @@ paths: description: Response content: application/json: - schema: *234 + schema: *237 examples: - default: *237 + default: *240 '403': *29 '404': *6 x-github: @@ -33890,10 +34414,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *96 - - *236 + - *94 + - *239 responses: - '204': *149 + '204': *152 '403': *29 '404': *6 x-github: @@ -33914,7 +34438,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *96 + - *94 - *17 - *19 - name: repository_query @@ -33952,7 +34476,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &238 + items: &241 title: Custom Property Value description: Custom property name and associated value type: object @@ -34019,7 +34543,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *96 + - *94 requestBody: required: true content: @@ -34039,7 +34563,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *238 + items: *241 required: - repository_names - properties @@ -34080,7 +34604,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *96 + - *94 - *17 - *19 responses: @@ -34092,7 +34616,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -34111,8 +34635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response if user is a public member @@ -34136,8 +34660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -34158,8 +34682,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *96 - - *135 + - *94 + - *138 responses: '204': description: Response @@ -34183,7 +34707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *96 + - *94 - name: type description: Specifies the types of repositories you want returned. in: query @@ -34229,9 +34753,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -34252,7 +34776,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *96 + - *94 requestBody: required: true content: @@ -34433,7 +34957,7 @@ paths: description: Response content: application/json: - schema: &315 + schema: &320 title: Full Repository description: Full Repository type: object @@ -34710,8 +35234,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *239 - required: *240 + properties: *242 + required: *243 nullable: true temp_clone_token: type: string @@ -34826,7 +35350,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &446 + properties: &456 url: type: string format: uri @@ -34842,12 +35366,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &447 + required: &457 - url - key - name - html_url - security_and_analysis: *241 + security_and_analysis: *244 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -34931,7 +35455,7 @@ paths: - network_count - subscribers_count examples: - default: &317 + default: &322 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -35449,10 +35973,10 @@ paths: category: orgs subcategory: rules parameters: - - *96 + - *94 - *17 - *19 - - &566 + - &576 name: targets description: | A comma-separated list of rule targets to filter by. @@ -35470,7 +35994,7 @@ paths: application/json: schema: type: array - items: &267 + items: &270 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -35505,7 +36029,7 @@ paths: source: type: string description: The name of the source - enforcement: &244 + enforcement: &247 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -35518,7 +36042,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &245 + items: &248 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -35583,7 +36107,7 @@ paths: conditions: nullable: true anyOf: - - &242 + - &245 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -35607,7 +36131,7 @@ paths: match. items: type: string - - &246 + - &249 title: Organization ruleset conditions type: object description: |- @@ -35621,7 +36145,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *242 + - *245 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -35655,7 +36179,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *242 + - *245 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -35677,7 +36201,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *242 + - *245 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -35690,7 +36214,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &243 + items: &246 title: Repository ruleset property targeting definition type: object @@ -35723,17 +36247,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *243 + items: *246 required: - repository_property rules: type: array - items: &567 + items: &577 title: Repository Rule type: object description: A repository rule. oneOf: - - &247 + - &250 title: creation description: Only allow users with bypass permission to create matching refs. @@ -35745,7 +36269,7 @@ paths: type: string enum: - creation - - &248 + - &251 title: update description: Only allow users with bypass permission to update matching refs. @@ -35766,7 +36290,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &249 + - &252 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -35778,7 +36302,7 @@ paths: type: string enum: - deletion - - &250 + - &253 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -35790,7 +36314,7 @@ paths: type: string enum: - required_linear_history - - &565 + - &575 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -35868,7 +36392,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &251 + - &254 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -35892,7 +36416,7 @@ paths: type: string required: - required_deployment_environments - - &252 + - &255 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -35904,7 +36428,7 @@ paths: type: string enum: - required_signatures - - &253 + - &256 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -35966,7 +36490,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &254 + - &257 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -36014,7 +36538,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &255 + - &258 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -36026,7 +36550,7 @@ paths: type: string enum: - non_fast_forward - - &256 + - &259 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -36062,7 +36586,7 @@ paths: required: - operator - pattern - - &257 + - &260 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -36098,7 +36622,7 @@ paths: required: - operator - pattern - - &258 + - &261 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -36134,7 +36658,7 @@ paths: required: - operator - pattern - - &259 + - &262 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -36170,7 +36694,7 @@ paths: required: - operator - pattern - - &260 + - &263 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -36206,7 +36730,7 @@ paths: required: - operator - pattern - - &261 + - &264 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -36231,7 +36755,7 @@ paths: type: string required: - restricted_file_paths - - &262 + - &265 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -36255,7 +36779,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &263 + - &266 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -36278,7 +36802,7 @@ paths: type: string required: - restricted_file_extensions - - &264 + - &267 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -36303,7 +36827,7 @@ paths: maximum: 100 required: - max_file_size - - &265 + - &268 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -36353,7 +36877,7 @@ paths: - repository_id required: - workflows - - &266 + - &269 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -36450,7 +36974,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *97 + '500': *100 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -36466,7 +36990,7 @@ paths: category: orgs subcategory: rules parameters: - - *96 + - *94 requestBody: description: Request body required: true @@ -36487,23 +37011,20 @@ paths: - push - repository default: branch - enforcement: *244 + enforcement: *247 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *245 - conditions: *246 + items: *248 + conditions: *249 rules: type: array description: An array of rules within the ruleset. - items: &269 + items: &272 title: Repository Rule type: object description: A repository rule. oneOf: - - *247 - - *248 - - *249 - *250 - *251 - *252 @@ -36521,6 +37042,9 @@ paths: - *264 - *265 - *266 + - *267 + - *268 + - *269 required: - name - enforcement @@ -36558,9 +37082,9 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: &268 + default: &271 value: id: 21 name: super cool ruleset @@ -36600,7 +37124,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *97 + '500': *100 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -36614,8 +37138,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *96 - - &568 + - *94 + - &578 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -36630,7 +37154,7 @@ paths: in: query schema: type: string - - &569 + - &579 name: time_period description: |- The time period to filter by. @@ -36646,14 +37170,14 @@ paths: - week - month default: day - - &570 + - &580 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &571 + - &581 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -36673,7 +37197,7 @@ paths: description: Response content: application/json: - schema: &572 + schema: &582 title: Rule Suites description: Response type: array @@ -36728,7 +37252,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &573 + default: &583 value: - id: 21 actor_id: 12 @@ -36752,7 +37276,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36771,8 +37295,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *96 - - &574 + - *94 + - &584 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -36788,7 +37312,7 @@ paths: description: Response content: application/json: - schema: &575 + schema: &585 title: Rule Suite description: Response type: object @@ -36887,7 +37411,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &576 + default: &586 value: id: 21 actor_id: 12 @@ -36922,7 +37446,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36948,7 +37472,7 @@ paths: category: orgs subcategory: rules parameters: - - *96 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -36960,11 +37484,11 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: *268 + default: *271 '404': *6 - '500': *97 + '500': *100 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -36980,7 +37504,7 @@ paths: category: orgs subcategory: rules parameters: - - *96 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37006,16 +37530,16 @@ paths: - tag - push - repository - enforcement: *244 + enforcement: *247 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *245 - conditions: *246 + items: *248 + conditions: *249 rules: description: An array of rules within the ruleset. type: array - items: *269 + items: *272 examples: default: value: @@ -37050,11 +37574,11 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: *268 + default: *271 '404': *6 - '500': *97 + '500': *100 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -37070,7 +37594,7 @@ paths: category: orgs subcategory: rules parameters: - - *96 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37081,7 +37605,7 @@ paths: '204': description: Response '404': *6 - '500': *97 + '500': *100 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -37093,7 +37617,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *96 + - *94 - *17 - *19 - name: ruleset_id @@ -37109,7 +37633,7 @@ paths: application/json: schema: type: array - items: &270 + items: &273 title: Ruleset version type: object description: The historical version of a ruleset @@ -37133,7 +37657,7 @@ paths: type: string format: date-time examples: - default: &578 + default: &588 value: - version_id: 3 actor: @@ -37151,7 +37675,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37168,7 +37692,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *96 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37186,9 +37710,9 @@ paths: description: Response content: application/json: - schema: &579 + schema: &589 allOf: - - *270 + - *273 - type: object required: - state @@ -37235,7 +37759,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37257,15 +37781,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *96 - - *271 - - *272 - - *273 + - *94 - *274 + - *275 + - *276 + - *277 - *48 - *19 - *17 - - &580 + - &590 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -37275,7 +37799,7 @@ paths: required: false schema: type: string - - &581 + - &591 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -37285,10 +37809,10 @@ paths: required: false schema: type: string - - *275 - - *276 - - *277 - *278 + - *279 + - *280 + - *281 responses: '200': description: Response @@ -37296,9 +37820,9 @@ paths: application/json: schema: type: array - items: *279 + items: *282 examples: - default: *280 + default: *283 headers: Link: *58 '404': *6 @@ -37308,6 +37832,233 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/pattern-configurations": + get: + summary: List organization pattern configurations + description: |- + Lists the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *94 + responses: + '200': + description: Response + content: + application/json: + schema: + title: Secret scanning pattern configuration + description: A collection of secret scanning patterns and their settings + related to push protection. + type: object + properties: + pattern_config_version: &285 + type: string + description: The version of the entity. This is used to confirm + you're updating the current version of the entity and mitigate + unintentionally overriding someone else's update. + nullable: true + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: &284 + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: string + description: The version of this pattern if it's a custom + pattern. + nullable: true + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this + pattern. + alert_total_percentage: + type: integer + description: The percentage of all alerts that this pattern + represents, rounded to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated + by this pattern. + false_positive_rate: + type: integer + description: The percentage of alerts from this pattern + that are false positives, rounded to the nearest integer. + bypass_rate: + type: integer + description: The percentage of blocks for this pattern that + were bypassed, rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this + pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: string + description: The push protection setting for this pattern + set at the enterprise level. Only present for partner + patterns when the organization has a parent enterprise. + enum: + - not-set + - disabled + - enabled + nullable: true + setting: + type: string + description: The current push protection setting for this + pattern. If this is `not-set`, then it inherits either + the enterprise setting if it exists or the default setting. + enum: + - not-set + - disabled + - enabled + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: *284 + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled + '403': *29 + '404': *6 + patch: + summary: Update organization pattern configurations + description: |- + Updates the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *94 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: *285 + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: *285 + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': *14 + '403': *29 + '404': *6 + '409': *47 + '422': *15 "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization @@ -37324,7 +38075,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *96 + - *94 - *48 - name: sort description: The property to sort the results by. @@ -37368,7 +38119,7 @@ paths: application/json: schema: type: array - items: &602 + items: &612 description: A repository security advisory. type: object properties: @@ -37588,7 +38339,7 @@ paths: login: type: string description: The username of the user credited. - type: *281 + type: *286 credits_detailed: type: array nullable: true @@ -37598,7 +38349,7 @@ paths: type: object properties: user: *4 - type: *281 + type: *286 state: type: string description: The state of the user's acceptance of the @@ -37622,7 +38373,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *155 + items: *158 private_fork: readOnly: true nullable: true @@ -37659,7 +38410,7 @@ paths: - private_fork additionalProperties: false examples: - default: &603 + default: &613 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -38038,7 +38789,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *96 + - *94 responses: '200': description: Response @@ -38046,9 +38797,9 @@ paths: application/json: schema: type: array - items: *282 + items: *287 examples: - default: *216 + default: *219 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38071,8 +38822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *96 - - *211 + - *94 + - *214 responses: '204': description: Response @@ -38097,8 +38848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *96 - - *211 + - *94 + - *214 responses: '204': description: Response @@ -38127,13 +38878,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &666 + schema: &676 type: object properties: total_minutes_used: @@ -38203,7 +38954,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &667 + default: &677 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -38233,13 +38984,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &668 + schema: &678 type: object properties: total_gigabytes_bandwidth_used: @@ -38257,7 +39008,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &669 + default: &679 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -38283,13 +39034,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: &670 + schema: &680 type: object properties: days_left_in_billing_cycle: @@ -38307,7 +39058,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &671 + default: &681 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -38331,7 +39082,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *96 + - *94 - *17 - *19 responses: @@ -38349,7 +39100,7 @@ paths: type: integer network_configurations: type: array - items: &283 + items: &288 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -38427,7 +39178,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *96 + - *94 requestBody: required: true content: @@ -38469,9 +39220,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *288 examples: - default: &284 + default: &289 value: id: 123456789ABCDEF name: My network configuration @@ -38499,8 +39250,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *96 - - &285 + - *94 + - &290 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -38512,9 +39263,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *288 examples: - default: *284 + default: *289 headers: Link: *58 x-github: @@ -38535,8 +39286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *96 - - *285 + - *94 + - *290 requestBody: required: true content: @@ -38575,9 +39326,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *288 examples: - default: *284 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38596,8 +39347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *96 - - *285 + - *94 + - *290 responses: '204': description: Response @@ -38620,7 +39371,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *96 + - *94 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -38704,8 +39455,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *96 - - *211 + - *94 + - *214 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -38737,13 +39488,13 @@ paths: application/json: schema: type: array - items: *286 + items: *291 examples: - default: *287 - '500': *97 + default: *292 + '500': *100 '403': *29 '404': *6 - '422': *288 + '422': *293 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38761,7 +39512,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *96 + - *94 - *17 - *19 responses: @@ -38771,9 +39522,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 headers: Link: *58 '403': *29 @@ -38795,7 +39546,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *96 + - *94 requestBody: required: true content: @@ -38867,7 +39618,7 @@ paths: description: Response content: application/json: - schema: &289 + schema: &294 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -38930,8 +39681,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *214 - required: *215 + properties: *217 + required: *218 nullable: true members_count: type: integer @@ -39177,7 +39928,7 @@ paths: - repos_count - organization examples: - default: &290 + default: &295 value: id: 1 node_id: MDQ6VGVhbTE= @@ -39247,16 +39998,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *96 - - *211 + - *94 + - *214 responses: '200': description: Response content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '404': *6 x-github: githubCloudOnly: false @@ -39277,8 +40028,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *96 - - *211 + - *94 + - *214 requestBody: required: false content: @@ -39340,16 +40091,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '201': description: Response content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '404': *6 '422': *15 '403': *29 @@ -39374,8 +40125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *96 - - *211 + - *94 + - *214 responses: '204': description: Response @@ -39401,8 +40152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *96 - - *211 + - *94 + - *214 - *48 - *17 - *19 @@ -39419,7 +40170,7 @@ paths: application/json: schema: type: array - items: &291 + items: &296 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -39518,7 +40269,7 @@ paths: - updated_at - url examples: - default: &618 + default: &629 value: - author: login: octocat @@ -39592,8 +40343,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *96 - - *211 + - *94 + - *214 requestBody: required: true content: @@ -39627,9 +40378,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: &292 + default: &297 value: author: login: octocat @@ -39701,9 +40452,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *96 - - *211 - - &293 + - *94 + - *214 + - &298 name: discussion_number description: The number that identifies the discussion. in: path @@ -39715,9 +40466,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *292 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39739,9 +40490,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 requestBody: required: false content: @@ -39764,9 +40515,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: &619 + default: &630 value: author: login: octocat @@ -39836,9 +40587,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 responses: '204': description: Response @@ -39864,9 +40615,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 - *48 - *17 - *19 @@ -39877,7 +40628,7 @@ paths: application/json: schema: type: array - items: &294 + items: &299 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -39949,7 +40700,7 @@ paths: - updated_at - url examples: - default: &620 + default: &631 value: - author: login: octocat @@ -40017,9 +40768,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 requestBody: required: true content: @@ -40041,9 +40792,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: &295 + default: &300 value: author: login: octocat @@ -40109,10 +40860,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *96 - - *211 - - *293 - - &296 + - *94 + - *214 + - *298 + - &301 name: comment_number description: The number that identifies the comment. in: path @@ -40124,9 +40875,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: *295 + default: *300 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40148,10 +40899,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *96 - - *211 - - *293 - - *296 + - *94 + - *214 + - *298 + - *301 requestBody: required: true content: @@ -40173,9 +40924,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: &621 + default: &632 value: author: login: octocat @@ -40239,10 +40990,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *96 - - *211 - - *293 - - *296 + - *94 + - *214 + - *298 + - *301 responses: '204': description: Response @@ -40268,10 +41019,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *96 - - *211 - - *293 - - *296 + - *94 + - *214 + - *298 + - *301 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -40297,7 +41048,7 @@ paths: application/json: schema: type: array - items: &297 + items: &302 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -40340,7 +41091,7 @@ paths: - content - created_at examples: - default: &299 + default: &304 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -40390,10 +41141,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *96 - - *211 - - *293 - - *296 + - *94 + - *214 + - *298 + - *301 requestBody: required: true content: @@ -40426,9 +41177,9 @@ paths: team discussion comment content: application/json: - schema: *297 + schema: *302 examples: - default: &298 + default: &303 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -40457,9 +41208,9 @@ paths: description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40482,11 +41233,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *96 - - *211 - - *293 - - *296 - - &300 + - *94 + - *214 + - *298 + - *301 + - &305 name: reaction_id description: The unique identifier of the reaction. in: path @@ -40518,9 +41269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -40546,9 +41297,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 x-github: @@ -40574,9 +41325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *96 - - *211 - - *293 + - *94 + - *214 + - *298 requestBody: required: true content: @@ -40608,16 +41359,16 @@ paths: description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40640,10 +41391,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *96 - - *211 - - *293 - - *300 + - *94 + - *214 + - *298 + - *305 responses: '204': description: Response @@ -40667,8 +41418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *96 - - *211 + - *94 + - *214 - *17 - *19 responses: @@ -40678,9 +41429,9 @@ paths: application/json: schema: type: array - items: *193 + items: *196 examples: - default: *194 + default: *197 headers: Link: *58 x-github: @@ -40702,8 +41453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *96 - - *211 + - *94 + - *214 - name: role description: Filters members returned by their role in the team. in: query @@ -40726,7 +41477,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -40756,15 +41507,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *96 - - *211 - - *135 + - *94 + - *214 + - *138 responses: '200': description: Response content: application/json: - schema: &301 + schema: &306 title: Team Membership description: Team Membership type: object @@ -40791,7 +41542,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &622 + response-if-user-is-a-team-maintainer: &633 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -40827,9 +41578,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *96 - - *211 - - *135 + - *94 + - *214 + - *138 requestBody: required: false content: @@ -40854,9 +41605,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *306 examples: - response-if-users-membership-with-team-is-now-pending: &623 + response-if-users-membership-with-team-is-now-pending: &634 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -40891,9 +41642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *96 - - *211 - - *135 + - *94 + - *214 + - *138 responses: '204': description: Response @@ -40918,8 +41669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *96 - - *211 + - *94 + - *214 - *17 - *19 responses: @@ -40929,7 +41680,7 @@ paths: application/json: schema: type: array - items: &302 + items: &307 title: Team Project description: A team's access to a project. type: object @@ -40997,7 +41748,7 @@ paths: - updated_at - permissions examples: - default: &624 + default: &635 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -41060,9 +41811,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *96 - - *211 - - &303 + - *94 + - *214 + - &308 name: project_id description: The unique identifier of the project. in: path @@ -41074,9 +41825,9 @@ paths: description: Response content: application/json: - schema: *302 + schema: *307 examples: - default: &625 + default: &636 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -41138,9 +41889,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *96 - - *211 - - *303 + - *94 + - *214 + - *308 requestBody: required: false content: @@ -41206,9 +41957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *96 - - *211 - - *303 + - *94 + - *214 + - *308 responses: '204': description: Response @@ -41235,8 +41986,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *96 - - *211 + - *94 + - *214 - *17 - *19 responses: @@ -41246,9 +41997,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -41277,16 +42028,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *96 - - *211 - - *304 - - *305 + - *94 + - *214 + - *309 + - *310 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &626 + schema: &637 title: Team Repository description: A team's access to a repository. type: object @@ -41855,10 +42606,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *96 - - *211 - - *304 - - *305 + - *94 + - *214 + - *309 + - *310 requestBody: required: false content: @@ -41903,10 +42654,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *96 - - *211 - - *304 - - *305 + - *94 + - *214 + - *309 + - *310 responses: '204': description: Response @@ -41930,8 +42681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *96 - - *211 + - *94 + - *214 - *17 - *19 responses: @@ -41941,9 +42692,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - response-if-child-teams-exist: &627 + response-if-child-teams-exist: &638 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -41996,7 +42747,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *96 + - *94 - name: security_product in: path description: The security feature to enable or disable. @@ -42070,7 +42821,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#get-a-project-card parameters: - - &306 + - &311 name: card_id description: The unique identifier of the card. in: path @@ -42082,7 +42833,7 @@ paths: description: Response content: application/json: - schema: &307 + schema: &312 title: Project Card description: Project cards represent a scope of work. type: object @@ -42149,7 +42900,7 @@ paths: - created_at - updated_at examples: - default: &308 + default: &313 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -42205,7 +42956,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#update-an-existing-project-card parameters: - - *306 + - *311 requestBody: required: false content: @@ -42232,9 +42983,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *312 examples: - default: *308 + default: *313 '304': *37 '403': *29 '401': *25 @@ -42261,7 +43012,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#delete-a-project-card parameters: - - *306 + - *311 responses: '204': description: Response @@ -42305,7 +43056,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#move-a-project-card parameters: - - *306 + - *311 requestBody: required: true content: @@ -42416,7 +43167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column parameters: - - &309 + - &314 name: column_id description: The unique identifier of the column. in: path @@ -42428,7 +43179,7 @@ paths: description: Response content: application/json: - schema: &310 + schema: &315 title: Project Column description: Project columns contain cards of work. type: object @@ -42474,7 +43225,7 @@ paths: - created_at - updated_at examples: - default: &311 + default: &316 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -42509,7 +43260,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column parameters: - - *309 + - *314 requestBody: required: true content: @@ -42533,9 +43284,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *315 examples: - default: *311 + default: *316 '304': *37 '403': *29 '401': *25 @@ -42560,7 +43311,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column parameters: - - *309 + - *314 responses: '204': description: Response @@ -42589,7 +43340,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#list-project-cards parameters: - - *309 + - *314 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -42610,7 +43361,7 @@ paths: application/json: schema: type: array - items: *307 + items: *312 examples: default: value: @@ -42669,7 +43420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/cards#create-a-project-card parameters: - - *309 + - *314 requestBody: required: true content: @@ -42709,9 +43460,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *312 examples: - default: *308 + default: *313 '304': *37 '403': *29 '401': *25 @@ -42721,8 +43472,8 @@ paths: application/json: schema: oneOf: - - *100 - - *101 + - *103 + - *104 '503': description: Response content: @@ -42767,7 +43518,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column parameters: - - *309 + - *314 requestBody: required: true content: @@ -42827,15 +43578,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#get-a-project parameters: - - *303 + - *308 responses: '200': description: Response content: application/json: - schema: *233 + schema: *236 examples: - default: &312 + default: &317 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -42892,7 +43643,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#update-a-project parameters: - - *303 + - *308 requestBody: required: false content: @@ -42938,9 +43689,9 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: - default: *312 + default: *317 '404': description: Not Found if the authenticated user does not have access to the project @@ -42961,7 +43712,7 @@ paths: items: type: string '401': *25 - '410': *313 + '410': *318 '422': *7 x-github: githubCloudOnly: false @@ -42984,7 +43735,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#delete-a-project parameters: - - *303 + - *308 responses: '204': description: Delete Success @@ -43005,7 +43756,7 @@ paths: items: type: string '401': *25 - '410': *313 + '410': *318 '404': *6 x-github: githubCloudOnly: false @@ -43029,7 +43780,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators parameters: - - *303 + - *308 - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's @@ -43056,7 +43807,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '404': *6 @@ -43086,8 +43837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator parameters: - - *303 - - *135 + - *308 + - *138 requestBody: required: false content: @@ -43139,8 +43890,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *303 - - *135 + - *308 + - *138 responses: '204': description: Response @@ -43171,8 +43922,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *303 - - *135 + - *308 + - *138 responses: '200': description: Response @@ -43245,7 +43996,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#list-project-columns parameters: - - *303 + - *308 - *17 - *19 responses: @@ -43255,7 +44006,7 @@ paths: application/json: schema: type: array - items: *310 + items: *315 examples: default: value: @@ -43293,7 +44044,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/columns#create-a-project-column parameters: - - *303 + - *308 requestBody: required: true content: @@ -43316,7 +44067,7 @@ paths: description: Response content: application/json: - schema: *310 + schema: *315 examples: default: value: @@ -43381,7 +44132,7 @@ paths: resources: type: object properties: - core: &314 + core: &319 title: Rate Limit type: object properties: @@ -43398,21 +44149,21 @@ paths: - remaining - reset - used - graphql: *314 - search: *314 - code_search: *314 - source_import: *314 - integration_manifest: *314 - code_scanning_upload: *314 - actions_runner_registration: *314 - scim: *314 - dependency_snapshots: *314 - dependency_sbom: *314 - code_scanning_autofix: *314 + graphql: *319 + search: *319 + code_search: *319 + source_import: *319 + integration_manifest: *319 + code_scanning_upload: *319 + actions_runner_registration: *319 + scim: *319 + dependency_snapshots: *319 + dependency_sbom: *319 + code_scanning_autofix: *319 required: - core - search - rate: *314 + rate: *319 required: - rate - resources @@ -43516,14 +44267,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *315 + schema: *320 examples: default-response: summary: Default response @@ -44024,7 +44775,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *316 + '301': *321 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44042,8 +44793,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -44290,10 +45041,10 @@ paths: description: Response content: application/json: - schema: *315 + schema: *320 examples: - default: *317 - '307': &318 + default: *322 + '307': &323 description: Temporary Redirect content: application/json: @@ -44322,8 +45073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -44345,7 +45096,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *318 + '307': *323 '404': *6 '409': *47 x-github: @@ -44369,11 +45120,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 - - &344 + - &354 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -44396,7 +45147,7 @@ paths: type: integer artifacts: type: array - items: &319 + items: &324 title: Artifact description: An artifact type: object @@ -44474,7 +45225,7 @@ paths: - expires_at - updated_at examples: - default: &345 + default: &355 value: total_count: 2 artifacts: @@ -44535,9 +45286,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *304 - - *305 - - &320 + - *309 + - *310 + - &325 name: artifact_id description: The unique identifier of the artifact. in: path @@ -44549,7 +45300,7 @@ paths: description: Response content: application/json: - schema: *319 + schema: *324 examples: default: value: @@ -44587,9 +45338,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *304 - - *305 - - *320 + - *309 + - *310 + - *325 responses: '204': description: Response @@ -44613,9 +45364,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *304 - - *305 - - *320 + - *309 + - *310 + - *325 - name: archive_format in: path required: true @@ -44629,7 +45380,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44652,14 +45403,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *321 + schema: *326 examples: default: value: @@ -44685,11 +45436,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 - - &322 + - &327 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -44723,7 +45474,7 @@ paths: description: Response content: application/json: - schema: &323 + schema: &328 title: Repository actions caches description: Repository actions caches type: object @@ -44765,7 +45516,7 @@ paths: - total_count - actions_caches examples: - default: &324 + default: &329 value: total_count: 1 actions_caches: @@ -44797,23 +45548,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *304 - - *305 + - *309 + - *310 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *322 + - *327 responses: '200': description: Response content: application/json: - schema: *323 + schema: *328 examples: - default: *324 + default: *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44833,8 +45584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *304 - - *305 + - *309 + - *310 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -44865,9 +45616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *304 - - *305 - - &325 + - *309 + - *310 + - &330 name: job_id description: The unique identifier of the job. in: path @@ -44879,7 +45630,7 @@ paths: description: Response content: application/json: - schema: &348 + schema: &358 title: Job description: Information of a job execution in a workflow run type: object @@ -45186,9 +45937,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *304 - - *305 - - *325 + - *309 + - *310 + - *330 responses: '302': description: Response @@ -45216,9 +45967,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *304 - - *305 - - *325 + - *309 + - *310 + - *330 requestBody: required: false content: @@ -45239,7 +45990,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -45263,8 +46014,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Status response @@ -45314,8 +46065,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -45349,7 +46100,7 @@ paths: description: Empty response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -45378,8 +46129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -45397,7 +46148,7 @@ paths: type: integer secrets: type: array - items: &350 + items: &360 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -45417,7 +46168,7 @@ paths: - created_at - updated_at examples: - default: &351 + default: &361 value: total_count: 2 secrets: @@ -45450,9 +46201,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *304 - - *305 - - *326 + - *309 + - *310 + - *331 - *19 responses: '200': @@ -45469,7 +46220,7 @@ paths: type: integer variables: type: array - items: &354 + items: &364 title: Actions Variable type: object properties: @@ -45499,7 +46250,7 @@ paths: - created_at - updated_at examples: - default: &355 + default: &365 value: total_count: 2 variables: @@ -45532,8 +46283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -45542,11 +46293,11 @@ paths: schema: type: object properties: - enabled: &328 + enabled: &333 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *111 - selected_actions_url: *327 + allowed_actions: *114 + selected_actions_url: *332 required: - enabled examples: @@ -45573,8 +46324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -45585,8 +46336,8 @@ paths: schema: type: object properties: - enabled: *328 - allowed_actions: *111 + enabled: *333 + allowed_actions: *114 required: - enabled examples: @@ -45615,14 +46366,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &329 + schema: &334 type: object properties: access_level: @@ -45639,7 +46390,7 @@ paths: required: - access_level examples: - default: &330 + default: &335 value: access_level: organization x-github: @@ -45663,15 +46414,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: application/json: - schema: *329 + schema: *334 examples: - default: *330 + default: *335 responses: '204': description: Response @@ -45681,6 +46432,196 @@ paths: previews: [] category: actions subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for a repository + description: |- + Gets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository + parameters: + - *309 + - *310 + responses: + '200': + description: Response + content: + application/json: + schema: *336 + examples: + default: + value: + days: 90 + maximum_allowed_days: 365 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for a repository + description: |- + Sets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository + parameters: + - *309 + - *310 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *337 + examples: + default: + summary: Set retention days + value: + days: 90 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for a repository + description: |- + Gets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - *309 + - *310 + responses: + '200': + description: Response + content: + application/json: + schema: *95 + examples: + default: *338 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for a repository + description: |- + Sets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - *309 + - *310 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *95 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for a repository + description: |- + Gets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - *309 + - *310 + responses: + '200': + description: Response + content: + application/json: + schema: *339 + examples: + default: *96 + '403': *29 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for a repository + description: |- + Sets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - *309 + - *310 + requestBody: + required: true + content: + application/json: + schema: *340 + examples: + default: *96 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/selected-actions": get: summary: Get allowed actions and reusable workflows for a repository @@ -45695,16 +46636,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *113 + schema: *116 examples: - default: *114 + default: *117 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -45723,8 +46664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -45732,9 +46673,9 @@ paths: required: false content: application/json: - schema: *113 + schema: *116 examples: - selected_actions: *114 + selected_actions: *117 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -45756,16 +46697,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *331 + schema: *341 examples: - default: *117 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45786,8 +46727,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Success response @@ -45798,9 +46739,9 @@ paths: required: true content: application/json: - schema: *332 + schema: *342 examples: - default: *117 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45827,8 +46768,8 @@ paths: in: query schema: type: string - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -45846,9 +46787,9 @@ paths: type: integer runners: type: array - items: *124 + items: *127 examples: - default: *125 + default: *128 headers: Link: *58 x-github: @@ -45872,8 +46813,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -45881,9 +46822,9 @@ paths: application/json: schema: type: array - items: *333 + items: *343 examples: - default: *334 + default: *344 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45905,8 +46846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -45949,7 +46890,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *335 + '201': *345 '404': *6 '422': *7 '409': *47 @@ -45980,16 +46921,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '201': description: Response content: application/json: - schema: *126 + schema: *129 examples: - default: *336 + default: *346 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46017,16 +46958,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '201': description: Response content: application/json: - schema: *126 + schema: *129 examples: - default: *337 + default: *347 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46048,17 +46989,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 responses: '200': description: Response content: application/json: - schema: *124 + schema: *127 examples: - default: *338 + default: *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46079,9 +47020,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 responses: '204': description: Response @@ -46107,11 +47048,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 responses: - '200': *128 + '200': *131 '404': *6 x-github: githubCloudOnly: false @@ -46133,9 +47074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 requestBody: required: true content: @@ -46159,7 +47100,7 @@ paths: - gpu - accelerated responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -46183,9 +47124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 requestBody: required: true content: @@ -46210,7 +47151,7 @@ paths: - gpu - accelerated responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -46234,11 +47175,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 + - *309 + - *310 + - *126 responses: - '200': *339 + '200': *349 '404': *6 x-github: githubCloudOnly: false @@ -46265,12 +47206,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *304 - - *305 - - *123 - - *340 + - *309 + - *310 + - *126 + - *350 responses: - '200': *128 + '200': *131 '404': *6 '422': *7 x-github: @@ -46296,9 +47237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *304 - - *305 - - &358 + - *309 + - *310 + - &368 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -46306,7 +47247,7 @@ paths: required: false schema: type: string - - &359 + - &369 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -46314,7 +47255,7 @@ paths: required: false schema: type: string - - &360 + - &370 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -46323,7 +47264,7 @@ paths: required: false schema: type: string - - &361 + - &371 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -46350,7 +47291,7 @@ paths: - pending - *17 - *19 - - &362 + - &372 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -46359,7 +47300,7 @@ paths: schema: type: string format: date-time - - &341 + - &351 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -46368,13 +47309,13 @@ paths: schema: type: boolean default: false - - &363 + - &373 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &364 + - &374 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -46397,7 +47338,7 @@ paths: type: integer workflow_runs: type: array - items: &342 + items: &352 title: Workflow Run description: An invocation of a workflow type: object @@ -46492,7 +47433,7 @@ paths: that triggered the run. type: array nullable: true - items: &383 + items: &393 title: Pull Request Minimal type: object properties: @@ -46611,7 +47552,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &387 + properties: &397 id: type: string description: SHA for the commit @@ -46662,7 +47603,7 @@ paths: - name - email nullable: true - required: &388 + required: &398 - id - tree_id - message @@ -46670,8 +47611,8 @@ paths: - author - committer nullable: true - repository: *122 - head_repository: *122 + repository: *125 + head_repository: *125 head_repository_id: type: integer example: 5 @@ -46709,7 +47650,7 @@ paths: - workflow_url - pull_requests examples: - default: &365 + default: &375 value: total_count: 1 workflow_runs: @@ -46945,24 +47886,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *304 - - *305 - - &343 + - *309 + - *310 + - &353 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *341 + - *351 responses: '200': description: Response content: application/json: - schema: *342 + schema: *352 examples: - default: &346 + default: &356 value: id: 30433642 name: Build @@ -47203,9 +48144,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '204': description: Response @@ -47228,9 +48169,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '200': description: Response @@ -47349,15 +48290,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '201': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -47384,12 +48325,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 - *17 - *19 - - *344 + - *354 responses: '200': description: Response @@ -47405,9 +48346,9 @@ paths: type: integer artifacts: type: array - items: *319 + items: *324 examples: - default: *345 + default: *355 headers: Link: *58 x-github: @@ -47431,25 +48372,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *304 - - *305 - - *343 - - &347 + - *309 + - *310 + - *353 + - &357 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *341 + - *351 responses: '200': description: Response content: application/json: - schema: *342 + schema: *352 examples: - default: *346 + default: *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47472,10 +48413,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *304 - - *305 - - *343 - - *347 + - *309 + - *310 + - *353 + - *357 - *17 - *19 responses: @@ -47493,9 +48434,9 @@ paths: type: integer jobs: type: array - items: *348 + items: *358 examples: - default: &349 + default: &359 value: total_count: 1 jobs: @@ -47608,10 +48549,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *304 - - *305 - - *343 - - *347 + - *309 + - *310 + - *353 + - *357 responses: '302': description: Response @@ -47639,15 +48580,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '202': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -47674,9 +48615,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 requestBody: required: true content: @@ -47743,15 +48684,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '202': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -47778,9 +48719,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -47810,9 +48751,9 @@ paths: type: integer jobs: type: array - items: *348 + items: *358 examples: - default: *349 + default: *359 headers: Link: *58 x-github: @@ -47837,9 +48778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '302': description: Response @@ -47866,14 +48807,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '204': description: Response '403': *29 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47895,9 +48836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '200': description: Response @@ -47957,7 +48898,7 @@ paths: items: type: object properties: - type: &467 + type: &477 type: string description: The type of reviewer. enum: @@ -47967,7 +48908,7 @@ paths: reviewer: anyOf: - *4 - - *155 + - *158 required: - environment - wait_timer @@ -48042,9 +48983,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 requestBody: required: true content: @@ -48091,7 +49032,7 @@ paths: application/json: schema: type: array - items: &462 + items: &472 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -48197,7 +49138,7 @@ paths: - created_at - updated_at examples: - default: &463 + default: &473 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -48253,9 +49194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 requestBody: required: false content: @@ -48276,7 +49217,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -48299,9 +49240,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 requestBody: required: false content: @@ -48322,7 +49263,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -48354,9 +49295,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *304 - - *305 - - *343 + - *309 + - *310 + - *353 responses: '200': description: Response @@ -48493,8 +49434,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -48512,9 +49453,9 @@ paths: type: integer secrets: type: array - items: *350 + items: *360 examples: - default: *351 + default: *361 headers: Link: *58 x-github: @@ -48539,16 +49480,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *352 + schema: *362 examples: - default: *353 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48570,17 +49511,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '200': description: Response content: application/json: - schema: *350 + schema: *360 examples: - default: &480 + default: &490 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -48606,9 +49547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 requestBody: required: true content: @@ -48639,7 +49580,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -48665,9 +49606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '204': description: Response @@ -48692,9 +49633,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *304 - - *305 - - *326 + - *309 + - *310 + - *331 - *19 responses: '200': @@ -48711,9 +49652,9 @@ paths: type: integer variables: type: array - items: *354 + items: *364 examples: - default: *355 + default: *365 headers: Link: *58 x-github: @@ -48736,8 +49677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -48764,7 +49705,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -48789,17 +49730,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *304 - - *305 - - *133 + - *309 + - *310 + - *136 responses: '200': description: Response content: application/json: - schema: *354 + schema: *364 examples: - default: &481 + default: &491 value: name: USERNAME value: octocat @@ -48825,9 +49766,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *304 - - *305 - - *133 + - *309 + - *310 + - *136 requestBody: required: true content: @@ -48869,9 +49810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *304 - - *305 - - *133 + - *309 + - *310 + - *136 responses: '204': description: Response @@ -48896,8 +49837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -48915,7 +49856,7 @@ paths: type: integer workflows: type: array - items: &356 + items: &366 title: Workflow description: A GitHub Actions workflow type: object @@ -49022,9 +49963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *304 - - *305 - - &357 + - *309 + - *310 + - &367 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -49039,7 +49980,7 @@ paths: description: Response content: application/json: - schema: *356 + schema: *366 examples: default: value: @@ -49072,9 +50013,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *304 - - *305 - - *357 + - *309 + - *310 + - *367 responses: '204': description: Response @@ -49099,9 +50040,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *304 - - *305 - - *357 + - *309 + - *310 + - *367 responses: '204': description: Response @@ -49152,9 +50093,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *304 - - *305 - - *357 + - *309 + - *310 + - *367 responses: '204': description: Response @@ -49181,19 +50122,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *304 - - *305 - - *357 - - *358 - - *359 - - *360 - - *361 + - *309 + - *310 + - *367 + - *368 + - *369 + - *370 + - *371 - *17 - *19 - - *362 - - *341 - - *363 - - *364 + - *372 + - *351 + - *373 + - *374 responses: '200': description: Response @@ -49209,9 +50150,9 @@ paths: type: integer workflow_runs: type: array - items: *342 + items: *352 examples: - default: *365 + default: *375 headers: Link: *58 x-github: @@ -49243,9 +50184,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *304 - - *305 - - *357 + - *309 + - *310 + - *367 responses: '200': description: Response @@ -49306,8 +50247,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *304 - - *305 + - *309 + - *310 - *48 - *17 - *40 @@ -49471,8 +50412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -49484,7 +50425,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '404': *6 @@ -49509,8 +50450,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *304 - - *305 + - *309 + - *310 - name: assignee in: path required: true @@ -49546,8 +50487,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -49659,8 +50600,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *40 - *41 @@ -49714,7 +50655,7 @@ paths: bundle_url: type: string examples: - default: *366 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49734,8 +50675,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -49743,7 +50684,7 @@ paths: application/json: schema: type: array - items: &367 + items: &377 title: Autolink reference description: An autolink reference. type: object @@ -49793,8 +50734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -49833,9 +50774,9 @@ paths: description: response content: application/json: - schema: *367 + schema: *377 examples: - default: &368 + default: &378 value: id: 1 key_prefix: TICKET- @@ -49866,9 +50807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *304 - - *305 - - &369 + - *309 + - *310 + - &379 name: autolink_id description: The unique identifier of the autolink. in: path @@ -49880,9 +50821,9 @@ paths: description: Response content: application/json: - schema: *367 + schema: *377 examples: - default: *368 + default: *378 '404': *6 x-github: githubCloudOnly: false @@ -49902,9 +50843,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *304 - - *305 - - *369 + - *309 + - *310 + - *379 responses: '204': description: Response @@ -49928,8 +50869,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response if Dependabot is enabled @@ -49977,8 +50918,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -49999,8 +50940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -50020,8 +50961,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *304 - - *305 + - *309 + - *310 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -50059,7 +51000,7 @@ paths: - url protected: type: boolean - protection: &371 + protection: &381 title: Branch Protection description: Branch Protection type: object @@ -50101,7 +51042,7 @@ paths: required: - contexts - checks - enforce_admins: &374 + enforce_admins: &384 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -50116,7 +51057,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &376 + required_pull_request_reviews: &386 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -50137,7 +51078,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *155 + items: *158 apps: description: The list of apps with review dismissal access. @@ -50166,7 +51107,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *155 + items: *158 apps: description: The list of apps allowed to bypass pull request requirements. @@ -50192,7 +51133,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &373 + restrictions: &383 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -50499,9 +51440,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *304 - - *305 - - &372 + - *309 + - *310 + - &382 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). @@ -50515,14 +51456,14 @@ paths: description: Response content: application/json: - schema: &382 + schema: &392 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &435 + commit: &445 title: Commit description: Commit type: object @@ -50556,7 +51497,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &370 + properties: &380 name: type: string example: '"Chris Wanstrath"' @@ -50571,7 +51512,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *370 + properties: *380 nullable: true message: type: string @@ -50592,7 +51533,7 @@ paths: required: - sha - url - verification: &487 + verification: &497 title: Verification type: object properties: @@ -50626,12 +51567,12 @@ paths: nullable: true oneOf: - *4 - - *131 + - *134 committer: nullable: true oneOf: - *4 - - *131 + - *134 parents: type: array items: @@ -50662,7 +51603,7 @@ paths: type: integer files: type: array - items: &450 + items: &460 title: Diff Entry description: Diff Entry type: object @@ -50745,7 +51686,7 @@ paths: - self protected: type: boolean - protection: *371 + protection: *381 protection_url: type: string format: uri @@ -50852,7 +51793,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *316 + '301': *321 '404': *6 x-github: githubCloudOnly: false @@ -50874,15 +51815,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *371 + schema: *381 examples: default: value: @@ -51076,9 +52017,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -51333,7 +52274,7 @@ paths: url: type: string format: uri - required_status_checks: &379 + required_status_checks: &389 title: Status Check Policy description: Status Check Policy type: object @@ -51409,7 +52350,7 @@ paths: items: *4 teams: type: array - items: *155 + items: *158 apps: type: array items: *5 @@ -51427,7 +52368,7 @@ paths: items: *4 teams: type: array - items: *155 + items: *158 apps: type: array items: *5 @@ -51485,7 +52426,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *373 + restrictions: *383 required_conversation_resolution: type: object properties: @@ -51597,9 +52538,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -51624,17 +52565,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *374 + schema: *384 examples: - default: &375 + default: &385 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -51656,17 +52597,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *374 + schema: *384 examples: - default: *375 + default: *385 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51685,9 +52626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -51712,17 +52653,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *376 + schema: *386 examples: - default: &377 + default: &387 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -51818,9 +52759,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -51918,9 +52859,9 @@ paths: description: Response content: application/json: - schema: *376 + schema: *386 examples: - default: *377 + default: *387 '422': *15 x-github: githubCloudOnly: false @@ -51941,9 +52882,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -51970,17 +52911,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *374 + schema: *384 examples: - default: &378 + default: &388 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -52003,17 +52944,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *374 + schema: *384 examples: - default: *378 + default: *388 '404': *6 x-github: githubCloudOnly: false @@ -52033,9 +52974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -52060,17 +53001,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *379 + schema: *389 examples: - default: &380 + default: &390 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -52096,9 +53037,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -52150,9 +53091,9 @@ paths: description: Response content: application/json: - schema: *379 + schema: *389 examples: - default: *380 + default: *390 '404': *6 '422': *15 x-github: @@ -52174,9 +53115,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -52200,9 +53141,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response @@ -52236,9 +53177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -52305,9 +53246,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -52371,9 +53312,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: content: application/json: @@ -52439,15 +53380,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response content: application/json: - schema: *373 + schema: *383 examples: default: value: @@ -52538,9 +53479,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '204': description: Response @@ -52563,9 +53504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response @@ -52575,7 +53516,7 @@ paths: type: array items: *5 examples: - default: &381 + default: &391 value: - id: 1 slug: octoapp @@ -52632,9 +53573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -52668,7 +53609,7 @@ paths: type: array items: *5 examples: - default: *381 + default: *391 '422': *15 x-github: githubCloudOnly: false @@ -52689,9 +53630,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -52725,7 +53666,7 @@ paths: type: array items: *5 examples: - default: *381 + default: *391 '422': *15 x-github: githubCloudOnly: false @@ -52746,9 +53687,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -52782,7 +53723,7 @@ paths: type: array items: *5 examples: - default: *381 + default: *391 '422': *15 x-github: githubCloudOnly: false @@ -52804,9 +53745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response @@ -52814,9 +53755,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 '404': *6 x-github: githubCloudOnly: false @@ -52836,9 +53777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -52874,9 +53815,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 '422': *15 x-github: githubCloudOnly: false @@ -52897,9 +53838,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: false content: @@ -52935,9 +53876,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 '422': *15 x-github: githubCloudOnly: false @@ -52958,9 +53899,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: content: application/json: @@ -52995,9 +53936,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 '422': *15 x-github: githubCloudOnly: false @@ -53019,9 +53960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 responses: '200': description: Response @@ -53031,7 +53972,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '404': *6 x-github: githubCloudOnly: false @@ -53055,9 +53996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -53090,7 +54031,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -53115,9 +54056,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -53150,7 +54091,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -53175,9 +54116,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -53210,7 +54151,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -53237,9 +54178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 requestBody: required: true content: @@ -53261,7 +54202,7 @@ paths: description: Response content: application/json: - schema: *382 + schema: *392 examples: default: value: @@ -53377,8 +54318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -53657,7 +54598,7 @@ paths: description: Response content: application/json: - schema: &384 + schema: &394 title: CheckRun description: A check performed on the code of a given code change type: object @@ -53776,8 +54717,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *383 - deployment: &684 + items: *393 + deployment: &694 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -54057,9 +54998,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *304 - - *305 - - &385 + - *309 + - *310 + - &395 name: check_run_id description: The unique identifier of the check run. in: path @@ -54071,9 +55012,9 @@ paths: description: Response content: application/json: - schema: *384 + schema: *394 examples: - default: &386 + default: &396 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -54173,9 +55114,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *304 - - *305 - - *385 + - *309 + - *310 + - *395 requestBody: required: true content: @@ -54415,9 +55356,9 @@ paths: description: Response content: application/json: - schema: *384 + schema: *394 examples: - default: *386 + default: *396 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54437,9 +55378,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *304 - - *305 - - *385 + - *309 + - *310 + - *395 - *17 - *19 responses: @@ -54534,15 +55475,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *304 - - *305 - - *385 + - *309 + - *310 + - *395 responses: '201': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -54580,8 +55521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -54603,7 +55544,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &389 + schema: &399 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -54667,7 +55608,7 @@ paths: nullable: true pull_requests: type: array - items: *383 + items: *393 nullable: true app: title: GitHub app @@ -54680,7 +55621,7 @@ paths: nullable: true properties: *61 required: *62 - repository: *122 + repository: *125 created_at: type: string format: date-time @@ -54689,12 +55630,12 @@ paths: type: string format: date-time nullable: true - head_commit: &710 + head_commit: &720 title: Simple Commit description: A commit. type: object - properties: *387 - required: *388 + properties: *397 + required: *398 latest_check_runs_count: type: integer check_runs_url: @@ -54722,7 +55663,7 @@ paths: - check_runs_url - pull_requests examples: - default: &390 + default: &400 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -55013,9 +55954,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *389 + schema: *399 examples: - default: *390 + default: *400 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55034,8 +55975,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -55096,7 +56037,7 @@ paths: required: - app_id - setting - repository: *122 + repository: *125 examples: default: value: @@ -55344,9 +56285,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *304 - - *305 - - &391 + - *309 + - *310 + - &401 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -55358,9 +56299,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *399 examples: - default: *390 + default: *400 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55383,17 +56324,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *304 - - *305 - - *391 - - &443 + - *309 + - *310 + - *401 + - &453 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &444 + - &454 name: status description: Returns check runs with the specified `status`. in: query @@ -55432,9 +56373,9 @@ paths: type: integer check_runs: type: array - items: *384 + items: *394 examples: - default: &445 + default: &455 value: total_count: 1 check_runs: @@ -55536,15 +56477,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *304 - - *305 - - *391 + - *309 + - *310 + - *401 responses: '201': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -55571,21 +56512,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *304 - - *305 - - *392 - - *393 + - *309 + - *310 + - *402 + - *403 - *19 - *17 - - &410 + - &420 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *394 - - &411 + schema: *404 + - &421 name: pr description: The number of the pull request for the results you want to list. in: query @@ -55610,13 +56551,13 @@ paths: be returned. in: query required: false - schema: *395 + schema: *405 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *396 + schema: *406 responses: '200': description: Response @@ -55629,12 +56570,12 @@ paths: properties: number: *54 created_at: *55 - updated_at: *139 + updated_at: *142 url: *56 html_url: *57 - instances_url: *397 - state: *144 - fixed_at: *140 + instances_url: *407 + state: *147 + fixed_at: *143 dismissed_by: title: Simple User description: A GitHub user. @@ -55642,12 +56583,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *141 - dismissed_reason: *398 - dismissed_comment: *399 - rule: *400 - tool: *401 - most_recent_instance: *402 + dismissed_at: *144 + dismissed_reason: *408 + dismissed_comment: *409 + rule: *410 + tool: *411 + most_recent_instance: *412 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -55770,7 +56711,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &403 + '403': &413 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -55797,9 +56738,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *304 - - *305 - - &404 + - *309 + - *310 + - &414 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -55813,17 +56754,17 @@ paths: description: Response content: application/json: - schema: &405 + schema: &415 type: object properties: number: *54 created_at: *55 - updated_at: *139 + updated_at: *142 url: *56 html_url: *57 - instances_url: *397 - state: *144 - fixed_at: *140 + instances_url: *407 + state: *147 + fixed_at: *143 dismissed_by: title: Simple User description: A GitHub user. @@ -55831,9 +56772,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *141 - dismissed_reason: *398 - dismissed_comment: *399 + dismissed_at: *144 + dismissed_reason: *408 + dismissed_comment: *409 rule: type: object properties: @@ -55887,8 +56828,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *401 - most_recent_instance: *402 + tool: *411 + most_recent_instance: *412 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -55984,7 +56925,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -56004,9 +56945,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 requestBody: required: true content: @@ -56021,8 +56962,8 @@ paths: enum: - open - dismissed - dismissed_reason: *398 - dismissed_comment: *399 + dismissed_reason: *408 + dismissed_comment: *409 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -56041,7 +56982,7 @@ paths: description: Response content: application/json: - schema: *405 + schema: *415 examples: default: value: @@ -56117,7 +57058,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &409 + '403': &419 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -56144,15 +57085,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 responses: '200': description: Response content: application/json: - schema: &406 + schema: &416 type: object properties: status: @@ -56178,13 +57119,13 @@ paths: - description - started_at examples: - default: &407 + default: &417 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &408 + '400': &418 description: Bad Request content: application/json: @@ -56195,7 +57136,7 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -56220,29 +57161,29 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 responses: '200': description: OK content: application/json: - schema: *406 + schema: *416 examples: - default: *407 + default: *417 '202': description: Accepted content: application/json: - schema: *406 + schema: *416 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *408 + '400': *418 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -56274,9 +57215,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 requestBody: required: false content: @@ -56321,8 +57262,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *408 - '403': *409 + '400': *418 + '403': *419 '404': *6 '422': description: Unprocessable Entity @@ -56346,13 +57287,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 - *19 - *17 - - *410 - - *411 + - *420 + - *421 responses: '200': description: Response @@ -56360,7 +57301,7 @@ paths: application/json: schema: type: array - items: *402 + items: *412 examples: default: value: @@ -56399,7 +57340,7 @@ paths: end_column: 50 classifications: - source - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -56433,25 +57374,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *304 - - *305 - - *392 - - *393 + - *309 + - *310 + - *402 + - *403 - *19 - *17 - - *411 + - *421 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *394 + schema: *404 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &414 + schema: &424 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -56472,23 +57413,23 @@ paths: application/json: schema: type: array - items: &415 + items: &425 type: object properties: - ref: *394 - commit_sha: &423 + ref: *404 + commit_sha: &433 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *412 + analysis_key: *422 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *413 + category: *423 error: type: string example: error reading field xyz @@ -56512,8 +57453,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *414 - tool: *401 + sarif_id: *424 + tool: *411 deletable: type: boolean warning: @@ -56574,7 +57515,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -56610,8 +57551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -56624,7 +57565,7 @@ paths: description: Response content: application/json: - schema: *415 + schema: *425 examples: response: summary: application/json response @@ -56678,7 +57619,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *403 + '403': *413 '404': *6 '422': description: Response if analysis could not be processed @@ -56765,8 +57706,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -56819,7 +57760,7 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *409 + '403': *419 '404': *6 '503': *65 x-github: @@ -56841,8 +57782,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -56850,7 +57791,7 @@ paths: application/json: schema: type: array - items: &416 + items: &426 title: CodeQL Database description: A CodeQL database. type: object @@ -56961,7 +57902,7 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -56990,8 +57931,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: language in: path description: The language of the CodeQL database. @@ -57003,7 +57944,7 @@ paths: description: Response content: application/json: - schema: *416 + schema: *426 examples: default: value: @@ -57035,9 +57976,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &452 + '302': &462 description: Found - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -57059,8 +58000,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *304 - - *305 + - *309 + - *310 - name: language in: path description: The language of the CodeQL database. @@ -57070,7 +58011,7 @@ paths: responses: '204': description: Response - '403': *409 + '403': *419 '404': *6 '503': *65 x-github: @@ -57098,8 +58039,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -57108,7 +58049,7 @@ paths: type: object additionalProperties: false properties: - language: &417 + language: &427 type: string description: The language targeted by the CodeQL query enum: @@ -57187,7 +58128,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &421 + schema: &431 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -57197,7 +58138,7 @@ paths: description: The ID of the variant analysis. controller_repo: *53 actor: *4 - query_language: *417 + query_language: *427 query_pack_url: type: string description: The download url for the query pack. @@ -57244,7 +58185,7 @@ paths: items: type: object properties: - repository: &418 + repository: &428 title: Repository Identifier description: Repository Identifier type: object @@ -57280,7 +58221,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &422 + analysis_status: &432 type: string description: The new status of the CodeQL variant analysis repository task. @@ -57312,7 +58253,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &419 + access_mismatch_repos: &429 type: object properties: repository_count: @@ -57326,7 +58267,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *418 + items: *428 required: - repository_count - repositories @@ -57348,8 +58289,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *419 - over_limit_repos: *419 + no_codeql_db_repos: *429 + over_limit_repos: *429 required: - access_mismatch_repos - not_found_repos @@ -57365,7 +58306,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &420 + value: &430 summary: Default response value: id: 1 @@ -57517,10 +58458,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *420 + value: *430 repository_lists: summary: Response for a successful variant analysis submission - value: *420 + value: *430 '404': *6 '422': description: Unable to process variant analysis submission @@ -57548,8 +58489,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *304 - - *305 + - *309 + - *310 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -57561,9 +58502,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *431 examples: - default: *420 + default: *430 '404': *6 '503': *65 x-github: @@ -57586,7 +58527,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *304 + - *309 - name: repo in: path description: The name of the controller repository. @@ -57621,7 +58562,7 @@ paths: type: object properties: repository: *53 - analysis_status: *422 + analysis_status: *432 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -57746,8 +58687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -57832,7 +58773,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *403 + '403': *413 '404': *6 '503': *65 x-github: @@ -57853,8 +58794,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -57921,7 +58862,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -57946,7 +58887,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *409 + '403': *419 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -58017,8 +58958,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -58026,7 +58967,7 @@ paths: schema: type: object properties: - commit_sha: *423 + commit_sha: *433 ref: type: string description: |- @@ -58084,7 +59025,7 @@ paths: schema: type: object properties: - id: *414 + id: *424 url: type: string description: The REST API URL for checking the status of the upload. @@ -58098,7 +59039,7 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *409 + '403': *419 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -58121,8 +59062,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *304 - - *305 + - *309 + - *310 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -58168,7 +59109,7 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *403 + '403': *413 '404': description: Not Found if the sarif id does not match any upload '503': *65 @@ -58193,8 +59134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -58250,7 +59191,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *149 + '204': *152 '304': *37 '403': *29 '404': *6 @@ -58275,8 +59216,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *304 - - *305 + - *309 + - *310 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -58396,8 +59337,8 @@ paths: parameters: - *17 - *19 - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -58413,7 +59354,7 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: default: value: @@ -58689,7 +59630,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': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -58711,8 +59652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -58775,17 +59716,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '400': *14 '401': *25 '403': *29 @@ -58814,8 +59755,8 @@ paths: parameters: - *17 - *19 - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -58855,7 +59796,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *97 + '500': *100 '400': *14 '401': *25 '403': *29 @@ -58879,8 +59820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -58915,14 +59856,14 @@ paths: type: integer machines: type: array - items: &634 + items: &645 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *425 - required: *426 + properties: *435 + required: *436 examples: - default: &635 + default: &646 value: total_count: 2 machines: @@ -58939,7 +59880,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -58962,8 +59903,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *304 - - *305 + - *309 + - *310 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -59047,8 +59988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *304 - - *305 + - *309 + - *310 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -59114,8 +60055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -59133,7 +60074,7 @@ paths: type: integer secrets: type: array - items: &430 + items: &440 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -59153,7 +60094,7 @@ paths: - created_at - updated_at examples: - default: *427 + default: *437 headers: Link: *58 x-github: @@ -59176,16 +60117,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *428 + schema: *438 examples: - default: *429 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59205,17 +60146,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '200': description: Response content: application/json: - schema: *430 + schema: *440 examples: - default: *431 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59235,9 +60176,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 requestBody: required: true content: @@ -59265,7 +60206,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -59289,9 +60230,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '204': description: Response @@ -59319,8 +60260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *304 - - *305 + - *309 + - *310 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -59362,7 +60303,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &432 + properties: &442 login: type: string example: octocat @@ -59455,7 +60396,7 @@ paths: user_view_type: type: string example: public - required: &433 + required: &443 - avatar_url - events_url - followers_url @@ -59529,9 +60470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *304 - - *305 - - *135 + - *309 + - *310 + - *138 responses: '204': description: Response if user is a collaborator @@ -59577,9 +60518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *304 - - *305 - - *135 + - *309 + - *310 + - *138 requestBody: required: false content: @@ -59605,7 +60546,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &500 + schema: &510 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -59616,7 +60557,7 @@ paths: example: 42 type: integer format: int64 - repository: *122 + repository: *125 invitee: title: Simple User description: A GitHub user. @@ -59794,7 +60735,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *100 + schema: *103 '403': *29 x-github: triggersNotification: true @@ -59834,9 +60775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *304 - - *305 - - *135 + - *309 + - *310 + - *138 responses: '204': description: No Content when collaborator was removed from the repository. @@ -59867,9 +60808,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *304 - - *305 - - *135 + - *309 + - *310 + - *138 responses: '200': description: if user has admin permissions @@ -59889,8 +60830,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *432 - required: *433 + properties: *442 + required: *443 nullable: true required: - permission @@ -59945,8 +60886,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -59956,7 +60897,7 @@ paths: application/json: schema: type: array - items: &434 + items: &444 title: Commit Comment description: Commit Comment type: object @@ -60014,7 +60955,7 @@ paths: - created_at - updated_at examples: - default: &437 + default: &447 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -60073,17 +61014,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '200': description: Response content: application/json: - schema: *434 + schema: *444 examples: - default: &438 + default: &448 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -60140,8 +61081,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -60164,7 +61105,7 @@ paths: description: Response content: application/json: - schema: *434 + schema: *444 examples: default: value: @@ -60215,8 +61156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '204': @@ -60238,8 +61179,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -60266,9 +61207,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 '404': *6 @@ -60289,8 +61230,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -60323,16 +61264,16 @@ paths: description: Reaction exists content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Reaction created content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -60354,10 +61295,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *304 - - *305 + - *309 + - *310 - *76 - - *300 + - *305 responses: '204': description: Response @@ -60406,8 +61347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *304 - - *305 + - *309 + - *310 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -60463,9 +61404,9 @@ paths: application/json: schema: type: array - items: *435 + items: *445 examples: - default: &551 + default: &561 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -60536,7 +61477,7 @@ paths: sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: Link: *58 - '500': *97 + '500': *100 '400': *14 '404': *6 '409': *47 @@ -60559,9 +61500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *304 - - *305 - - &436 + - *309 + - *310 + - &446 name: commit_sha description: The SHA of the commit. in: path @@ -60633,9 +61574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *304 - - *305 - - *436 + - *309 + - *310 + - *446 - *17 - *19 responses: @@ -60645,9 +61586,9 @@ paths: application/json: schema: type: array - items: *434 + items: *444 examples: - default: *437 + default: *447 headers: Link: *58 x-github: @@ -60675,9 +61616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *304 - - *305 - - *436 + - *309 + - *310 + - *446 requestBody: required: true content: @@ -60712,9 +61653,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *444 examples: - default: *438 + default: *448 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -60742,9 +61683,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *304 - - *305 - - *436 + - *309 + - *310 + - *446 - *17 - *19 responses: @@ -60754,7 +61695,7 @@ paths: application/json: schema: type: array - items: &542 + items: &552 title: Pull Request Simple description: Pull Request Simple type: object @@ -60860,8 +61801,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *439 - required: *440 + properties: *449 + required: *450 nullable: true active_lock_reason: type: string @@ -60906,7 +61847,7 @@ paths: nullable: true requested_teams: type: array - items: *155 + items: *158 nullable: true head: type: object @@ -60957,7 +61898,7 @@ paths: _links: type: object properties: - comments: &441 + comments: &451 title: Link description: Hypermedia Link type: object @@ -60966,13 +61907,13 @@ paths: type: string required: - href - commits: *441 - statuses: *441 - html: *441 - issue: *441 - review_comments: *441 - review_comment: *441 - self: *441 + commits: *451 + statuses: *451 + html: *451 + issue: *451 + review_comments: *451 + review_comment: *451 + self: *451 required: - comments - commits @@ -60983,7 +61924,7 @@ paths: - review_comment - self author_association: *63 - auto_merge: &544 + auto_merge: &554 title: Auto merge description: The status of auto merging a pull request. type: object @@ -61046,7 +61987,7 @@ paths: - author_association - auto_merge examples: - default: &543 + default: &553 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -61583,11 +62524,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *304 - - *305 + - *309 + - *310 - *19 - *17 - - &442 + - &452 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -61602,9 +62543,9 @@ paths: description: Response content: application/json: - schema: *435 + schema: *445 examples: - default: &529 + default: &539 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -61690,7 +62631,7 @@ paths: ..... '422': *15 '404': *6 - '500': *97 + '500': *100 '503': *65 '409': *47 x-github: @@ -61717,11 +62658,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *304 - - *305 - - *442 - - *443 - - *444 + - *309 + - *310 + - *452 + - *453 + - *454 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -61755,9 +62696,9 @@ paths: type: integer check_runs: type: array - items: *384 + items: *394 examples: - default: *445 + default: *455 headers: Link: *58 x-github: @@ -61782,9 +62723,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *304 - - *305 - - *442 + - *309 + - *310 + - *452 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -61792,7 +62733,7 @@ paths: schema: type: integer example: 1 - - *443 + - *453 - *17 - *19 responses: @@ -61810,7 +62751,7 @@ paths: type: integer check_suites: type: array - items: *389 + items: *399 examples: default: value: @@ -62010,9 +62951,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *304 - - *305 - - *442 + - *309 + - *310 + - *452 - *17 - *19 responses: @@ -62079,7 +63020,7 @@ paths: type: string total_count: type: integer - repository: *122 + repository: *125 commit_url: type: string format: uri @@ -62210,9 +63151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *304 - - *305 - - *442 + - *309 + - *310 + - *452 - *17 - *19 responses: @@ -62222,7 +63163,7 @@ paths: application/json: schema: type: array - items: &607 + items: &617 title: Status description: The status of a commit. type: object @@ -62303,7 +63244,7 @@ paths: site_admin: false headers: Link: *58 - '301': *316 + '301': *321 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62331,8 +63272,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -62361,20 +63302,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *446 - required: *447 + properties: *456 + required: *457 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &448 + properties: &458 url: type: string format: uri html_url: type: string format: uri - required: &449 + required: &459 - url - html_url nullable: true @@ -62388,26 +63329,26 @@ paths: contributing: title: Community Health File type: object - properties: *448 - required: *449 + properties: *458 + required: *459 nullable: true readme: title: Community Health File type: object - properties: *448 - required: *449 + properties: *458 + required: *459 nullable: true issue_template: title: Community Health File type: object - properties: *448 - required: *449 + properties: *458 + required: *459 nullable: true pull_request_template: title: Community Health File type: object - properties: *448 - required: *449 + properties: *458 + required: *459 nullable: true required: - code_of_conduct @@ -62534,8 +63475,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *304 - - *305 + - *309 + - *310 - *19 - *17 - name: basehead @@ -62578,8 +63519,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *435 - merge_base_commit: *435 + base_commit: *445 + merge_base_commit: *445 status: type: string enum: @@ -62599,10 +63540,10 @@ paths: example: 6 commits: type: array - items: *435 + items: *445 files: type: array - items: *450 + items: *460 required: - url - html_url @@ -62845,7 +63786,7 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *97 + '500': *100 '503': *65 x-github: githubCloudOnly: false @@ -62888,8 +63829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *304 - - *305 + - *309 + - *310 - name: path description: path parameter in: path @@ -63032,7 +63973,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &451 + response-if-content-is-a-file: &461 summary: Response if content is a file value: type: file @@ -63164,7 +64105,7 @@ paths: - size - type - url - - &556 + - &566 title: Content File description: Content File type: object @@ -63365,7 +64306,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *451 + response-if-content-is-a-file: *461 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -63434,7 +64375,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *452 + '302': *462 '304': *37 x-github: githubCloudOnly: false @@ -63457,8 +64398,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *304 - - *305 + - *309 + - *310 - name: path description: path parameter in: path @@ -63551,7 +64492,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &463 title: File Commit description: File Commit type: object @@ -63703,7 +64644,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *463 examples: example-for-creating-a-file: value: @@ -63757,7 +64698,7 @@ paths: schema: oneOf: - *3 - - &482 + - &492 description: Repository rule violation was detected type: object properties: @@ -63778,7 +64719,7 @@ paths: items: type: object properties: - placeholder_id: &599 + placeholder_id: &609 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -63810,8 +64751,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *304 - - *305 + - *309 + - *310 - name: path description: path parameter in: path @@ -63872,7 +64813,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *463 examples: default: value: @@ -63927,8 +64868,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *304 - - *305 + - *309 + - *310 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -64051,22 +64992,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *304 - - *305 - - *156 - - *157 - - *158 + - *309 + - *310 - *159 + - *160 + - *161 + - *162 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *160 - - *161 - - *162 - *163 + - *164 + - *165 + - *166 - *48 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -64086,8 +65027,8 @@ paths: default: 30 - *40 - *41 - - *164 - - *165 + - *167 + - *168 responses: '200': description: Response @@ -64095,7 +65036,7 @@ paths: application/json: schema: type: array - items: &456 + items: &466 type: object description: A Dependabot alert. properties: @@ -64141,13 +65082,13 @@ paths: - unknown - direct - transitive - security_advisory: *454 + security_advisory: *464 security_vulnerability: *52 url: *56 html_url: *57 created_at: *55 - updated_at: *139 - dismissed_at: *141 + updated_at: *142 + dismissed_at: *144 dismissed_by: title: Simple User description: A GitHub user. @@ -64171,8 +65112,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *140 - auto_dismissed_at: *455 + fixed_at: *143 + auto_dismissed_at: *465 required: - number - state @@ -64402,9 +65343,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *304 - - *305 - - &457 + - *309 + - *310 + - &467 name: alert_number in: path description: |- @@ -64419,7 +65360,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *466 examples: default: value: @@ -64532,9 +65473,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *304 - - *305 - - *457 + - *309 + - *310 + - *467 requestBody: required: true content: @@ -64579,7 +65520,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *466 examples: default: value: @@ -64708,8 +65649,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -64727,7 +65668,7 @@ paths: type: integer secrets: type: array - items: &460 + items: &470 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -64780,16 +65721,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *458 + schema: *468 examples: - default: *459 + default: *469 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64809,15 +65750,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '200': description: Response content: application/json: - schema: *460 + schema: *470 examples: default: value: @@ -64843,9 +65784,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 requestBody: required: true content: @@ -64873,7 +65814,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -64897,9 +65838,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *304 - - *305 - - *130 + - *309 + - *310 + - *133 responses: '204': description: Response @@ -64921,8 +65862,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *304 - - *305 + - *309 + - *310 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -65082,8 +66023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -65322,8 +66263,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -65398,7 +66339,7 @@ paths: - version - url additionalProperties: false - metadata: &461 + metadata: &471 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -65431,7 +66372,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *461 + metadata: *471 resolved: type: object description: A collection of resolved package dependencies. @@ -65444,7 +66385,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *461 + metadata: *471 relationship: type: string description: A notation of whether a dependency is requested @@ -65573,8 +66514,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *304 - - *305 + - *309 + - *310 - name: sha description: The SHA recorded at creation time. in: query @@ -65614,9 +66555,9 @@ paths: application/json: schema: type: array - items: *462 + items: *472 examples: - default: *463 + default: *473 headers: Link: *58 x-github: @@ -65682,8 +66623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -65764,7 +66705,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *472 examples: simple-example: summary: Simple example @@ -65837,9 +66778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *304 - - *305 - - &464 + - *309 + - *310 + - &474 name: deployment_id description: deployment_id parameter in: path @@ -65851,7 +66792,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *472 examples: default: value: @@ -65916,9 +66857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *304 - - *305 - - *464 + - *309 + - *310 + - *474 responses: '204': description: Response @@ -65940,9 +66881,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *304 - - *305 - - *464 + - *309 + - *310 + - *474 - *17 - *19 responses: @@ -65952,7 +66893,7 @@ paths: application/json: schema: type: array - items: &465 + items: &475 title: Deployment Status description: The status of a deployment. type: object @@ -66113,9 +67054,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *304 - - *305 - - *464 + - *309 + - *310 + - *474 requestBody: required: true content: @@ -66190,9 +67131,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *475 examples: - default: &466 + default: &476 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -66248,9 +67189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *304 - - *305 - - *464 + - *309 + - *310 + - *474 - name: status_id in: path required: true @@ -66261,9 +67202,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *475 examples: - default: *466 + default: *476 '404': *6 x-github: githubCloudOnly: false @@ -66288,8 +67229,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -66346,8 +67287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -66364,7 +67305,7 @@ paths: type: integer environments: type: array - items: &468 + items: &478 title: Environment description: Details of a deployment environment type: object @@ -66416,7 +67357,7 @@ paths: type: type: string example: wait_timer - wait_timer: &470 + wait_timer: &480 type: integer example: 30 description: The amount of time to delay a job after @@ -66453,11 +67394,11 @@ paths: items: type: object properties: - type: *467 + type: *477 reviewer: anyOf: - *4 - - *155 + - *158 required: - id - node_id @@ -66477,7 +67418,7 @@ paths: - id - node_id - type - deployment_branch_policy: &471 + deployment_branch_policy: &481 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -66593,9 +67534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *304 - - *305 - - &469 + - *309 + - *310 + - &479 name: environment_name in: path required: true @@ -66608,9 +67549,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *478 examples: - default: &472 + default: &482 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -66694,9 +67635,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 requestBody: required: false content: @@ -66705,7 +67646,7 @@ paths: type: object nullable: true properties: - wait_timer: *470 + wait_timer: *480 prevent_self_review: type: boolean example: false @@ -66722,13 +67663,13 @@ paths: items: type: object properties: - type: *467 + type: *477 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *471 + deployment_branch_policy: *481 additionalProperties: false examples: default: @@ -66748,9 +67689,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *478 examples: - default: *472 + default: *482 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -66774,9 +67715,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 responses: '204': description: Default response @@ -66801,9 +67742,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 - *17 - *19 responses: @@ -66821,7 +67762,7 @@ paths: example: 2 branch_policies: type: array - items: &473 + items: &483 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -66878,9 +67819,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 requestBody: required: true content: @@ -66926,9 +67867,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *483 examples: - example-wildcard: &474 + example-wildcard: &484 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -66970,10 +67911,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *304 - - *305 - - *469 - - &475 + - *309 + - *310 + - *479 + - &485 name: branch_policy_id in: path required: true @@ -66985,9 +67926,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *483 examples: - default: *474 + default: *484 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67006,10 +67947,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *304 - - *305 - - *469 - - *475 + - *309 + - *310 + - *479 + - *485 requestBody: required: true content: @@ -67037,9 +67978,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *483 examples: - default: *474 + default: *484 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67058,10 +67999,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *304 - - *305 - - *469 - - *475 + - *309 + - *310 + - *479 + - *485 responses: '204': description: Response @@ -67086,9 +68027,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *469 - - *305 - - *304 + - *479 + - *310 + - *309 responses: '200': description: List of deployment protection rules @@ -67104,7 +68045,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &476 + items: &486 title: Deployment protection rule description: Deployment protection rule type: object @@ -67123,7 +68064,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &477 + app: &487 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -67222,9 +68163,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *469 - - *305 - - *304 + - *479 + - *310 + - *309 requestBody: content: application/json: @@ -67245,9 +68186,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *476 + schema: *486 examples: - default: &478 + default: &488 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -67282,9 +68223,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *469 - - *305 - - *304 + - *479 + - *310 + - *309 - *19 - *17 responses: @@ -67303,7 +68244,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *477 + items: *487 examples: default: value: @@ -67338,10 +68279,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *304 - - *305 - - *469 - - &479 + - *309 + - *310 + - *479 + - &489 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -67353,9 +68294,9 @@ paths: description: Response content: application/json: - schema: *476 + schema: *486 examples: - default: *478 + default: *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67376,10 +68317,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *469 - - *305 - - *304 - *479 + - *310 + - *309 + - *489 responses: '204': description: Response @@ -67405,9 +68346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 - *17 - *19 responses: @@ -67425,9 +68366,9 @@ paths: type: integer secrets: type: array - items: *350 + items: *360 examples: - default: *351 + default: *361 headers: Link: *58 x-github: @@ -67452,17 +68393,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 responses: '200': description: Response content: application/json: - schema: *352 + schema: *362 examples: - default: *353 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67484,18 +68425,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *304 - - *305 - - *469 - - *130 + - *309 + - *310 + - *479 + - *133 responses: '200': description: Response content: application/json: - schema: *350 + schema: *360 examples: - default: *480 + default: *490 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67517,10 +68458,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *304 - - *305 - - *469 - - *130 + - *309 + - *310 + - *479 + - *133 requestBody: required: true content: @@ -67551,7 +68492,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -67577,10 +68518,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *304 - - *305 - - *469 - - *130 + - *309 + - *310 + - *479 + - *133 responses: '204': description: Default response @@ -67605,10 +68546,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *304 - - *305 - - *469 - - *326 + - *309 + - *310 + - *479 + - *331 - *19 responses: '200': @@ -67625,9 +68566,9 @@ paths: type: integer variables: type: array - items: *354 + items: *364 examples: - default: *355 + default: *365 headers: Link: *58 x-github: @@ -67650,9 +68591,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *304 - - *305 - - *469 + - *309 + - *310 + - *479 requestBody: required: true content: @@ -67679,7 +68620,7 @@ paths: description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -67704,18 +68645,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *304 - - *305 - - *469 - - *133 + - *309 + - *310 + - *479 + - *136 responses: '200': description: Response content: application/json: - schema: *354 + schema: *364 examples: - default: *481 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67736,10 +68677,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *304 - - *305 - - *133 - - *469 + - *309 + - *310 + - *136 + - *479 requestBody: required: true content: @@ -67781,10 +68722,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *304 - - *305 - - *133 - - *469 + - *309 + - *310 + - *136 + - *479 responses: '204': description: Response @@ -67806,8 +68747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -67884,8 +68825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *304 - - *305 + - *309 + - *310 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -67907,7 +68848,7 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: default: value: @@ -68044,8 +68985,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -68077,9 +69018,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *320 examples: - default: *317 + default: *322 '400': *14 '422': *15 '403': *29 @@ -68100,8 +69041,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -68160,8 +69101,8 @@ paths: application/json: schema: oneOf: - - *100 - - *482 + - *103 + - *492 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68186,8 +69127,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *304 - - *305 + - *309 + - *310 - name: file_sha in: path required: true @@ -68286,8 +69227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -68396,7 +69337,7 @@ paths: description: Response content: application/json: - schema: &483 + schema: &493 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -68610,15 +69551,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *304 - - *305 - - *436 + - *309 + - *310 + - *446 responses: '200': description: Response content: application/json: - schema: *483 + schema: *493 examples: default: value: @@ -68674,9 +69615,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *304 - - *305 - - &484 + - *309 + - *310 + - &494 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -68693,7 +69634,7 @@ paths: application/json: schema: type: array - items: &485 + items: &495 title: Git Reference description: Git references within a repository type: object @@ -68768,17 +69709,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *304 - - *305 - - *484 + - *309 + - *310 + - *494 responses: '200': description: Response content: application/json: - schema: *485 + schema: *495 examples: - default: &486 + default: &496 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -68807,8 +69748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -68837,9 +69778,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *495 examples: - default: *486 + default: *496 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -68865,9 +69806,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *304 - - *305 - - *484 + - *309 + - *310 + - *494 requestBody: required: true content: @@ -68896,9 +69837,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *495 examples: - default: *486 + default: *496 '422': *15 '409': *47 x-github: @@ -68916,9 +69857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *304 - - *305 - - *484 + - *309 + - *310 + - *494 responses: '204': description: Response @@ -68973,8 +69914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -69041,7 +69982,7 @@ paths: description: Response content: application/json: - schema: &488 + schema: &498 title: Git Tag description: Metadata for a Git tag type: object @@ -69092,7 +70033,7 @@ paths: - sha - type - url - verification: *487 + verification: *497 required: - sha - url @@ -69102,7 +70043,7 @@ paths: - tag - message examples: - default: &489 + default: &499 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -69175,8 +70116,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *304 - - *305 + - *309 + - *310 - name: tag_sha in: path required: true @@ -69187,9 +70128,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *498 examples: - default: *489 + default: *499 '404': *6 '409': *47 x-github: @@ -69213,8 +70154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -69287,7 +70228,7 @@ paths: description: Response content: application/json: - schema: &490 + schema: &500 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -69383,8 +70324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *304 - - *305 + - *309 + - *310 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -69407,7 +70348,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *500 examples: default-response: summary: Default response @@ -69466,8 +70407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -69477,7 +70418,7 @@ paths: application/json: schema: type: array - items: &491 + items: &501 title: Webhook description: Webhooks for repositories. type: object @@ -69531,7 +70472,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &718 + last_response: &728 title: Hook Response type: object properties: @@ -69605,8 +70546,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -69658,9 +70599,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *501 examples: - default: &492 + default: &502 value: type: Repository id: 12345678 @@ -69708,17 +70649,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 responses: '200': description: Response content: application/json: - schema: *491 + schema: *501 examples: - default: *492 + default: *502 '404': *6 x-github: githubCloudOnly: false @@ -69738,9 +70679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 requestBody: required: true content: @@ -69785,9 +70726,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *501 examples: - default: *492 + default: *502 '422': *15 '404': *6 x-github: @@ -69808,9 +70749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 responses: '204': description: Response @@ -69834,9 +70775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 responses: '200': description: Response @@ -69863,9 +70804,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 requestBody: required: false content: @@ -69909,11 +70850,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 - *17 - - *174 + - *177 responses: '200': description: Response @@ -69921,9 +70862,9 @@ paths: application/json: schema: type: array - items: *175 + items: *178 examples: - default: *176 + default: *179 '400': *14 '422': *15 x-github: @@ -69942,18 +70883,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 - *16 responses: '200': description: Response content: application/json: - schema: *177 + schema: *180 examples: - default: *178 + default: *181 '400': *14 '422': *15 x-github: @@ -69972,9 +70913,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 - *16 responses: '202': *39 @@ -69997,9 +70938,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 responses: '204': description: Response @@ -70024,9 +70965,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *304 - - *305 - - *173 + - *309 + - *310 + - *176 responses: '204': description: Response @@ -70084,14 +71025,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &493 + schema: &503 title: Import description: A repository import from an external source. type: object @@ -70190,7 +71131,7 @@ paths: - html_url - authors_url examples: - default: &496 + default: &506 value: vcs: subversion use_lfs: true @@ -70206,7 +71147,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &494 + '503': &504 description: Unavailable due to service under maintenance. content: application/json: @@ -70235,8 +71176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -70284,7 +71225,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *503 examples: default: value: @@ -70309,7 +71250,7 @@ paths: type: string '422': *15 '404': *6 - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70337,8 +71278,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -70387,7 +71328,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *503 examples: example-1: summary: Example 1 @@ -70435,7 +71376,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70458,12 +71399,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70489,9 +71430,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *304 - - *305 - - &658 + - *309 + - *310 + - &668 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -70505,7 +71446,7 @@ paths: application/json: schema: type: array - items: &495 + items: &505 title: Porter Author description: Porter Author type: object @@ -70559,7 +71500,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70584,8 +71525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *304 - - *305 + - *309 + - *310 - name: author_id in: path required: true @@ -70615,7 +71556,7 @@ paths: description: Response content: application/json: - schema: *495 + schema: *505 examples: default: value: @@ -70628,7 +71569,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70652,8 +71593,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -70694,7 +71635,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70722,8 +71663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -70750,11 +71691,11 @@ paths: description: Response content: application/json: - schema: *493 + schema: *503 examples: - default: *496 + default: *506 '422': *15 - '503': *494 + '503': *504 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70777,8 +71718,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -70786,8 +71727,8 @@ paths: application/json: schema: *22 examples: - default: *497 - '301': *316 + default: *507 + '301': *321 '404': *6 x-github: githubCloudOnly: false @@ -70807,8 +71748,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -70816,12 +71757,12 @@ paths: application/json: schema: anyOf: - - *191 + - *194 - type: object properties: {} additionalProperties: false examples: - default: &499 + default: &509 value: limit: collaborators_only origin: repository @@ -70846,13 +71787,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: application/json: - schema: *498 + schema: *508 examples: default: summary: Example request body @@ -70864,9 +71805,9 @@ paths: description: Response content: application/json: - schema: *191 + schema: *194 examples: - default: *499 + default: *509 '409': description: Response x-github: @@ -70888,8 +71829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -70912,8 +71853,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -70923,9 +71864,9 @@ paths: application/json: schema: type: array - items: *500 + items: *510 examples: - default: &651 + default: &661 value: - id: 1 repository: @@ -71056,9 +71997,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *304 - - *305 - - *195 + - *309 + - *310 + - *198 requestBody: required: false content: @@ -71087,7 +72028,7 @@ paths: description: Response content: application/json: - schema: *500 + schema: *510 examples: default: value: @@ -71218,9 +72159,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *304 - - *305 - - *195 + - *309 + - *310 + - *198 responses: '204': description: Response @@ -71251,8 +72192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *304 - - *305 + - *309 + - *310 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -71300,7 +72241,7 @@ paths: required: false schema: type: string - - *199 + - *202 - name: sort description: What to sort results by. in: query @@ -71325,7 +72266,7 @@ paths: type: array items: *77 examples: - default: &511 + default: &519 value: - id: 1 node_id: MDU6SXNzdWUx @@ -71473,7 +72414,7 @@ paths: state_reason: completed headers: Link: *58 - '301': *316 + '301': *321 '422': *15 '404': *6 x-github: @@ -71502,8 +72443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -71587,7 +72528,7 @@ paths: application/json: schema: *77 examples: - default: &506 + default: &516 value: id: 1 node_id: MDU6SXNzdWUx @@ -71743,7 +72684,7 @@ paths: '422': *15 '503': *65 '404': *6 - '410': *313 + '410': *318 x-github: triggersNotification: true githubCloudOnly: false @@ -71771,8 +72712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *87 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. @@ -71793,9 +72734,9 @@ paths: application/json: schema: type: array - items: *501 + items: *511 examples: - default: &508 + default: &518 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -71853,17 +72794,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '200': description: Response content: application/json: - schema: *501 + schema: *511 examples: - default: &502 + default: &512 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -71917,8 +72858,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -71941,9 +72882,9 @@ paths: description: Response content: application/json: - schema: *501 + schema: *511 examples: - default: *502 + default: *512 '422': *15 x-github: githubCloudOnly: false @@ -71961,8 +72902,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '204': @@ -71983,8 +72924,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -72011,9 +72952,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 '404': *6 @@ -72034,8 +72975,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -72068,16 +73009,16 @@ paths: description: Reaction exists content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Reaction created content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -72099,10 +73040,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *304 - - *305 + - *309 + - *310 - *76 - - *300 + - *305 responses: '204': description: Response @@ -72122,8 +73063,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -72133,7 +73074,7 @@ paths: application/json: schema: type: array - items: &505 + items: &515 title: Issue Event description: Issue Event type: object @@ -72176,8 +73117,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *503 - required: *504 + properties: *513 + required: *514 nullable: true label: title: Issue Event Label @@ -72221,7 +73162,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *155 + requested_team: *158 dismissed_review: title: Issue Event Dismissed Review type: object @@ -72484,8 +73425,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *304 - - *305 + - *309 + - *310 - name: event_id in: path required: true @@ -72496,7 +73437,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *515 examples: default: value: @@ -72689,7 +73630,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *313 + '410': *318 '403': *29 x-github: githubCloudOnly: false @@ -72723,9 +73664,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *304 - - *305 - - &507 + - *309 + - *310 + - &517 name: issue_number description: The number that identifies the issue. in: path @@ -72739,10 +73680,10 @@ paths: application/json: schema: *77 examples: - default: *506 - '301': *316 + default: *516 + '301': *321 '404': *6 - '410': *313 + '410': *318 '304': *37 x-github: githubCloudOnly: false @@ -72767,9 +73708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: false content: @@ -72875,13 +73816,13 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 '422': *15 '503': *65 '403': *29 - '301': *316 + '301': *321 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72899,9 +73840,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: false content: @@ -72929,7 +73870,7 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72945,9 +73886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: content: application/json: @@ -72974,7 +73915,7 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72996,9 +73937,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - name: assignee in: path required: true @@ -73038,9 +73979,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - *67 - *17 - *19 @@ -73051,13 +73992,13 @@ paths: application/json: schema: type: array - items: *501 + items: *511 examples: - default: *508 + default: *518 headers: Link: *58 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73086,9 +74027,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: true content: @@ -73110,16 +74051,16 @@ paths: description: Response content: application/json: - schema: *501 + schema: *511 examples: - default: *502 + default: *512 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *313 + '410': *318 '422': *15 '404': *6 x-github: @@ -73128,6 +74069,210 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": + get: + summary: List dependencies an issue is blocked by + description: |- + You can use the REST API to list the dependencies an issue is blocked by. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - *309 + - *310 + - *517 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *77 + examples: + default: *519 + headers: + Link: *58 + '301': *321 + '404': *6 + '410': *318 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + post: + summary: Add a dependency an issue is blocked by + description: |- + You can use the REST API to add a 'blocked by' relationship to an issue. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - *309 + - *310 + - *517 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: *77 + examples: + default: *516 + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': *321 + '403': *29 + '410': *318 + '422': *15 + '404': *6 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": + delete: + summary: Remove dependency an issue is blocked by + description: |- + You can use the REST API to remove a dependency that an issue is blocked by. + + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - *309 + - *310 + - *517 + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *77 + examples: + default: *516 + '301': *321 + '400': *14 + '401': *25 + '403': *29 + '404': *6 + '410': *318 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": + get: + summary: List dependencies an issue is blocking + description: |- + You can use the REST API to list the dependencies an issue is blocking. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - *309 + - *310 + - *517 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *77 + examples: + default: *519 + headers: + Link: *58 + '301': *321 + '404': *6 + '410': *318 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events @@ -73139,9 +74284,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - *17 - *19 responses: @@ -73155,7 +74300,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &512 + - &522 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -73209,7 +74354,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &513 + - &523 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -73345,7 +74490,7 @@ paths: - performed_via_github_app - assignee - assigner - - &514 + - &524 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -73396,7 +74541,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &515 + - &525 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -73447,7 +74592,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &516 + - &526 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -73501,7 +74646,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &517 + - &527 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -73535,7 +74680,7 @@ paths: properties: *61 required: *62 review_requester: *4 - requested_team: *155 + requested_team: *158 requested_reviewer: *4 required: - review_requester @@ -73548,7 +74693,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &518 + - &528 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -73582,7 +74727,7 @@ paths: properties: *61 required: *62 review_requester: *4 - requested_team: *155 + requested_team: *158 requested_reviewer: *4 required: - review_requester @@ -73595,7 +74740,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &519 + - &529 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -73655,7 +74800,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &520 + - &530 title: Locked Issue Event description: Locked Issue Event type: object @@ -73703,7 +74848,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &521 + - &531 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -73769,7 +74914,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &522 + - &532 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -73835,7 +74980,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &523 + - &533 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -73901,7 +75046,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &524 + - &534 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -73992,7 +75137,7 @@ paths: color: red headers: Link: *58 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74009,9 +75154,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - *17 - *19 responses: @@ -74021,7 +75166,7 @@ paths: application/json: schema: type: array - items: &509 + items: &520 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -74068,7 +75213,7 @@ paths: - color - default examples: - default: &510 + default: &521 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -74086,9 +75231,9 @@ paths: default: false headers: Link: *58 - '301': *316 + '301': *321 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74105,9 +75250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: false content: @@ -74166,12 +75311,12 @@ paths: application/json: schema: type: array - items: *509 + items: *520 examples: - default: *510 - '301': *316 + default: *521 + '301': *321 '404': *6 - '410': *313 + '410': *318 '422': *15 x-github: githubCloudOnly: false @@ -74188,9 +75333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: false content: @@ -74250,12 +75395,12 @@ paths: application/json: schema: type: array - items: *509 + items: *520 examples: - default: *510 - '301': *316 + default: *521 + '301': *321 '404': *6 - '410': *313 + '410': *318 '422': *15 x-github: githubCloudOnly: false @@ -74272,15 +75417,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 responses: '204': description: Response - '301': *316 + '301': *321 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74299,9 +75444,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - name: name in: path required: true @@ -74314,7 +75459,7 @@ paths: application/json: schema: type: array - items: *509 + items: *520 examples: default: value: @@ -74325,9 +75470,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *316 + '301': *321 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74347,9 +75492,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: false content: @@ -74377,7 +75522,7 @@ paths: '204': description: Response '403': *29 - '410': *313 + '410': *318 '404': *6 '422': *15 x-github: @@ -74395,9 +75540,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 responses: '204': description: Response @@ -74419,9 +75564,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -74447,13 +75592,13 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74471,9 +75616,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: true content: @@ -74505,16 +75650,16 @@ paths: description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -74536,10 +75681,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *304 + - *309 + - *310 + - *517 - *305 - - *507 - - *300 responses: '204': description: Response @@ -74568,9 +75713,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: true content: @@ -74594,7 +75739,7 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -74627,9 +75772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - *17 - *19 responses: @@ -74641,11 +75786,11 @@ paths: type: array items: *77 examples: - default: *511 + default: *519 headers: Link: *58 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74673,9 +75818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: true content: @@ -74704,14 +75849,14 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *313 + '410': *318 '422': *15 '404': *6 x-github: @@ -74731,9 +75876,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 requestBody: required: true content: @@ -74766,7 +75911,7 @@ paths: application/json: schema: *77 examples: - default: *506 + default: *516 '403': *29 '404': *6 '422': *7 @@ -74788,9 +75933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *304 - - *305 - - *507 + - *309 + - *310 + - *517 - *17 - *19 responses: @@ -74805,19 +75950,19 @@ paths: description: Timeline Event type: object anyOf: - - *512 - - *513 - - *514 - - *515 - - *516 - - *517 - - *518 - - *519 - - *520 - - *521 - *522 - *523 - *524 + - *525 + - *526 + - *527 + - *528 + - *529 + - *530 + - *531 + - *532 + - *533 + - *534 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -75122,7 +76267,7 @@ paths: type: string comments: type: array - items: &545 + items: &555 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -75331,7 +76476,7 @@ paths: type: string comments: type: array - items: *434 + items: *444 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -75620,7 +76765,7 @@ paths: headers: Link: *58 '404': *6 - '410': *313 + '410': *318 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75637,8 +76782,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -75648,7 +76793,7 @@ paths: application/json: schema: type: array - items: &525 + items: &535 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -75714,8 +76859,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -75751,9 +76896,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *535 examples: - default: &526 + default: &536 value: id: 1 key: ssh-rsa AAA... @@ -75787,9 +76932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *304 - - *305 - - &527 + - *309 + - *310 + - &537 name: key_id description: The unique identifier of the key. in: path @@ -75801,9 +76946,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *535 examples: - default: *526 + default: *536 '404': *6 x-github: githubCloudOnly: false @@ -75821,9 +76966,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *304 - - *305 - - *527 + - *309 + - *310 + - *537 responses: '204': description: Response @@ -75843,8 +76988,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -75854,9 +76999,9 @@ paths: application/json: schema: type: array - items: *509 + items: *520 examples: - default: *510 + default: *521 headers: Link: *58 '404': *6 @@ -75877,8 +77022,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -75914,9 +77059,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *520 examples: - default: &528 + default: &538 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -75948,8 +77093,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *304 - - *305 + - *309 + - *310 - name: name in: path required: true @@ -75960,9 +77105,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *520 examples: - default: *528 + default: *538 '404': *6 x-github: githubCloudOnly: false @@ -75979,8 +77124,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *304 - - *305 + - *309 + - *310 - name: name in: path required: true @@ -76019,7 +77164,7 @@ paths: description: Response content: application/json: - schema: *509 + schema: *520 examples: default: value: @@ -76045,8 +77190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *304 - - *305 + - *309 + - *310 - name: name in: path required: true @@ -76072,8 +77217,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -76112,9 +77257,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *304 - - *305 - - *410 + - *309 + - *310 + - *420 responses: '200': description: Response @@ -76259,8 +77404,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -76325,8 +77470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -76360,9 +77505,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *435 + schema: *445 examples: - default: *529 + default: *539 '204': description: Response when already merged '404': @@ -76387,8 +77532,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *304 - - *305 + - *309 + - *310 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -76429,12 +77574,12 @@ paths: application/json: schema: type: array - items: &530 + items: &540 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *439 - required: *440 + properties: *449 + required: *450 examples: default: value: @@ -76490,8 +77635,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -76531,9 +77676,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *540 examples: - default: &531 + default: &541 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -76592,9 +77737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *304 - - *305 - - &532 + - *309 + - *310 + - &542 name: milestone_number description: The number that identifies the milestone. in: path @@ -76606,9 +77751,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *540 examples: - default: *531 + default: *541 '404': *6 x-github: githubCloudOnly: false @@ -76625,9 +77770,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *304 - - *305 - - *532 + - *309 + - *310 + - *542 requestBody: required: false content: @@ -76665,9 +77810,9 @@ paths: description: Response content: application/json: - schema: *530 + schema: *540 examples: - default: *531 + default: *541 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76683,9 +77828,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *304 - - *305 - - *532 + - *309 + - *310 + - *542 responses: '204': description: Response @@ -76706,9 +77851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *304 - - *305 - - *532 + - *309 + - *310 + - *542 - *17 - *19 responses: @@ -76718,9 +77863,9 @@ paths: application/json: schema: type: array - items: *509 + items: *520 examples: - default: *510 + default: *521 headers: Link: *58 x-github: @@ -76739,12 +77884,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *304 - - *305 - - *533 - - *534 + - *309 + - *310 + - *543 + - *544 - *67 - - *535 + - *545 - *17 - *19 responses: @@ -76756,7 +77901,7 @@ paths: type: array items: *90 examples: - default: *536 + default: *546 headers: Link: *58 x-github: @@ -76780,8 +77925,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -76839,14 +77984,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &537 + schema: &547 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -76971,7 +78116,7 @@ paths: - custom_404 - public examples: - default: &538 + default: &548 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -77012,8 +78157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -77067,9 +78212,9 @@ paths: description: Response content: application/json: - schema: *537 + schema: *547 examples: - default: *538 + default: *548 '422': *15 '409': *47 x-github: @@ -77092,8 +78237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -77192,8 +78337,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -77219,8 +78364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -77230,7 +78375,7 @@ paths: application/json: schema: type: array - items: &539 + items: &549 title: Page Build description: Page Build type: object @@ -77324,8 +78469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *304 - - *305 + - *309 + - *310 responses: '201': description: Response @@ -77370,16 +78515,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *539 + schema: *549 examples: - default: &540 + default: &550 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -77427,8 +78572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *304 - - *305 + - *309 + - *310 - name: build_id in: path required: true @@ -77439,9 +78584,9 @@ paths: description: Response content: application/json: - schema: *539 + schema: *549 examples: - default: *540 + default: *550 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77461,8 +78606,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -77567,9 +78712,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *304 - - *305 - - &541 + - *309 + - *310 + - &551 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -77627,11 +78772,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *304 - - *305 - - *541 + - *309 + - *310 + - *551 responses: - '204': *149 + '204': *152 '404': *6 x-github: githubCloudOnly: false @@ -77656,8 +78801,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -77888,7 +79033,7 @@ paths: description: Empty response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -77915,8 +79060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Private vulnerability reporting status @@ -77953,10 +79098,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: - '204': *149 + '204': *152 '422': *14 x-github: githubCloudOnly: false @@ -77975,10 +79120,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: - '204': *149 + '204': *152 '422': *14 x-github: githubCloudOnly: false @@ -77999,8 +79144,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-repository-projects parameters: - - *304 - - *305 + - *309 + - *310 - name: state description: Indicates the state of the projects to return. in: query @@ -78021,7 +79166,7 @@ paths: application/json: schema: type: array - items: *233 + items: *236 examples: default: value: @@ -78061,7 +79206,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *313 + '410': *318 '422': *7 x-github: githubCloudOnly: false @@ -78084,8 +79229,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#create-a-repository-project parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -78111,13 +79256,13 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: - default: *312 + default: *317 '401': *25 '403': *29 '404': *6 - '410': *313 + '410': *318 '422': *7 x-github: githubCloudOnly: false @@ -78140,8 +79285,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -78149,7 +79294,7 @@ paths: application/json: schema: type: array - items: *238 + items: *241 examples: default: value: @@ -78180,8 +79325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -78193,7 +79338,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *238 + items: *241 required: - properties examples: @@ -78243,8 +79388,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *304 - - *305 + - *309 + - *310 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -78304,9 +79449,9 @@ paths: application/json: schema: type: array - items: *542 + items: *552 examples: - default: *543 + default: *553 headers: Link: *58 '304': *37 @@ -78338,8 +79483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -78404,7 +79549,7 @@ paths: description: Response content: application/json: - schema: &547 + schema: &557 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -78515,8 +79660,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *439 - required: *440 + properties: *449 + required: *450 nullable: true active_lock_reason: type: string @@ -78561,7 +79706,7 @@ paths: nullable: true requested_teams: type: array - items: *282 + items: *287 nullable: true head: type: object @@ -78600,14 +79745,14 @@ paths: _links: type: object properties: - comments: *441 - commits: *441 - statuses: *441 - html: *441 - issue: *441 - review_comments: *441 - review_comment: *441 - self: *441 + comments: *451 + commits: *451 + statuses: *451 + html: *451 + issue: *451 + review_comments: *451 + review_comment: *451 + self: *451 required: - comments - commits @@ -78618,7 +79763,7 @@ paths: - review_comment - self author_association: *63 - auto_merge: *544 + auto_merge: *554 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -78710,7 +79855,7 @@ paths: - merged_by - review_comments examples: - default: &548 + default: &558 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -79237,8 +80382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: sort in: query required: false @@ -79267,9 +80412,9 @@ paths: application/json: schema: type: array - items: *545 + items: *555 examples: - default: &550 + default: &560 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -79346,17 +80491,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '200': description: Response content: application/json: - schema: *545 + schema: *555 examples: - default: &546 + default: &556 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -79431,8 +80576,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -79455,9 +80600,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *555 examples: - default: *546 + default: *556 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79473,8 +80618,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *304 - - *305 + - *309 + - *310 - *76 responses: '204': @@ -79496,8 +80641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -79524,9 +80669,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 '404': *6 @@ -79547,8 +80692,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *304 - - *305 + - *309 + - *310 - *76 requestBody: required: true @@ -79581,16 +80726,16 @@ paths: description: Reaction exists content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Reaction created content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -79612,10 +80757,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *304 - - *305 + - *309 + - *310 - *76 - - *300 + - *305 responses: '204': description: Response @@ -79658,9 +80803,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *304 - - *305 - - &549 + - *309 + - *310 + - &559 name: pull_number description: The number that identifies the pull request. in: path @@ -79673,9 +80818,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *547 + schema: *557 examples: - default: *548 + default: *558 '304': *37 '404': *6 '406': @@ -79683,7 +80828,7 @@ paths: content: application/json: schema: *3 - '500': *97 + '500': *100 '503': *65 x-github: githubCloudOnly: false @@ -79710,9 +80855,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: false content: @@ -79754,9 +80899,9 @@ paths: description: Response content: application/json: - schema: *547 + schema: *557 examples: - default: *548 + default: *558 '422': *15 '403': *29 x-github: @@ -79778,9 +80923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: true content: @@ -79840,17 +80985,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '401': *25 '403': *29 '404': *6 @@ -79880,9 +81025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 - *87 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -79903,9 +81048,9 @@ paths: application/json: schema: type: array - items: *545 + items: *555 examples: - default: *550 + default: *560 headers: Link: *58 x-github: @@ -79938,9 +81083,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: true content: @@ -80045,7 +81190,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *555 examples: example-for-a-multi-line-comment: value: @@ -80133,9 +81278,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 - *76 requestBody: required: true @@ -80158,7 +81303,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *555 examples: default: value: @@ -80244,9 +81389,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 - *17 - *19 responses: @@ -80256,9 +81401,9 @@ paths: application/json: schema: type: array - items: *435 + items: *445 examples: - default: *551 + default: *561 headers: Link: *58 x-github: @@ -80288,9 +81433,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 - *17 - *19 responses: @@ -80300,7 +81445,7 @@ paths: application/json: schema: type: array - items: *450 + items: *460 examples: default: value: @@ -80318,7 +81463,7 @@ paths: headers: Link: *58 '422': *15 - '500': *97 + '500': *100 '503': *65 x-github: githubCloudOnly: false @@ -80338,9 +81483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 responses: '204': description: Response if pull request has been merged @@ -80363,9 +81508,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: false content: @@ -80476,9 +81621,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 responses: '200': description: Response @@ -80494,7 +81639,7 @@ paths: items: *4 teams: type: array - items: *155 + items: *158 required: - users - teams @@ -80553,9 +81698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: false content: @@ -80592,7 +81737,7 @@ paths: description: Response content: application/json: - schema: *542 + schema: *552 examples: default: value: @@ -81128,9 +82273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: true content: @@ -81164,7 +82309,7 @@ paths: description: Response content: application/json: - schema: *542 + schema: *552 examples: default: value: @@ -81669,9 +82814,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 - *17 - *19 responses: @@ -81681,7 +82826,7 @@ paths: application/json: schema: type: array - items: &552 + items: &562 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -81832,9 +82977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: false content: @@ -81920,9 +83065,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *562 examples: - default: &554 + default: &564 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -81985,10 +83130,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 - - &553 + - *309 + - *310 + - *559 + - &563 name: review_id description: The unique identifier of the review. in: path @@ -82000,9 +83145,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *562 examples: - default: &555 + default: &565 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -82061,10 +83206,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 - - *553 + - *309 + - *310 + - *559 + - *563 requestBody: required: true content: @@ -82087,7 +83232,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *562 examples: default: value: @@ -82149,18 +83294,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 - - *553 + - *309 + - *310 + - *559 + - *563 responses: '200': description: Response content: application/json: - schema: *552 + schema: *562 examples: - default: *554 + default: *564 '422': *7 '404': *6 x-github: @@ -82187,10 +83332,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *304 - - *305 - - *549 - - *553 + - *309 + - *310 + - *559 + - *563 - *17 - *19 responses: @@ -82273,9 +83418,9 @@ paths: _links: type: object properties: - self: *441 - html: *441 - pull_request: *441 + self: *451 + html: *451 + pull_request: *451 required: - self - html @@ -82425,10 +83570,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 - - *553 + - *309 + - *310 + - *559 + - *563 requestBody: required: true content: @@ -82456,7 +83601,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *562 examples: default: value: @@ -82519,10 +83664,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *304 - - *305 - - *549 - - *553 + - *309 + - *310 + - *559 + - *563 requestBody: required: true content: @@ -82557,9 +83702,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *562 examples: - default: *555 + default: *565 '404': *6 '422': *7 '403': *29 @@ -82581,9 +83726,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *304 - - *305 - - *549 + - *309 + - *310 + - *559 requestBody: required: false content: @@ -82646,8 +83791,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *304 - - *305 + - *309 + - *310 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -82660,9 +83805,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *566 examples: - default: &557 + default: &567 value: type: file encoding: base64 @@ -82704,8 +83849,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *304 - - *305 + - *309 + - *310 - name: dir description: The alternate path to look for a README file in: path @@ -82725,9 +83870,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *566 examples: - default: *557 + default: *567 '404': *6 '422': *15 x-github: @@ -82749,8 +83894,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -82760,7 +83905,7 @@ paths: application/json: schema: type: array - items: &558 + items: &568 title: Release description: A release. type: object @@ -82827,7 +83972,7 @@ paths: author: *4 assets: type: array - items: &559 + items: &569 title: Release Asset description: Data related to a release. type: object @@ -83014,8 +84159,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -83091,9 +84236,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *568 examples: - default: &562 + default: &572 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -83198,9 +84343,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *304 - - *305 - - &560 + - *309 + - *310 + - &570 name: asset_id description: The unique identifier of the asset. in: path @@ -83212,9 +84357,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *569 examples: - default: &561 + default: &571 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -83249,7 +84394,7 @@ paths: type: User site_admin: false '404': *6 - '302': *452 + '302': *462 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83265,9 +84410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *304 - - *305 - - *560 + - *309 + - *310 + - *570 requestBody: required: false content: @@ -83295,9 +84440,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *569 examples: - default: *561 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83313,9 +84458,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *304 - - *305 - - *560 + - *309 + - *310 + - *570 responses: '204': description: Response @@ -83339,8 +84484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -83425,16 +84570,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *558 + schema: *568 examples: - default: *562 + default: *572 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83451,8 +84596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *304 - - *305 + - *309 + - *310 - name: tag description: tag parameter in: path @@ -83465,9 +84610,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *568 examples: - default: *562 + default: *572 '404': *6 x-github: githubCloudOnly: false @@ -83489,9 +84634,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *304 - - *305 - - &563 + - *309 + - *310 + - &573 name: release_id description: The unique identifier of the release. in: path @@ -83505,9 +84650,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *558 + schema: *568 examples: - default: *562 + default: *572 '401': description: Unauthorized x-github: @@ -83525,9 +84670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 requestBody: required: false content: @@ -83591,9 +84736,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *568 examples: - default: *562 + default: *572 '404': description: Not Found if the discussion category name is invalid content: @@ -83614,9 +84759,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 responses: '204': description: Response @@ -83636,9 +84781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 - *17 - *19 responses: @@ -83648,7 +84793,7 @@ paths: application/json: schema: type: array - items: *559 + items: *569 examples: default: value: @@ -83729,9 +84874,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 - name: name in: query required: true @@ -83757,7 +84902,7 @@ paths: description: Response for successful upload content: application/json: - schema: *559 + schema: *569 examples: response-for-successful-upload: value: @@ -83812,9 +84957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -83838,9 +84983,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 '404': *6 @@ -83861,9 +85006,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *304 - - *305 - - *563 + - *309 + - *310 + - *573 requestBody: required: true content: @@ -83893,16 +85038,16 @@ paths: description: Reaction exists content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '201': description: Reaction created content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -83924,10 +85069,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *304 + - *309 + - *310 + - *573 - *305 - - *563 - - *300 responses: '204': description: Response @@ -83951,9 +85096,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *304 - - *305 - - *372 + - *309 + - *310 + - *382 - *17 - *19 responses: @@ -83969,8 +85114,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *247 - - &564 + - *250 + - &574 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -83989,66 +85134,66 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *248 - - *564 - - allOf: - - *249 - - *564 - - allOf: - - *250 - - *564 - - allOf: - - *565 - - *564 - allOf: - *251 - - *564 + - *574 - allOf: - *252 - - *564 + - *574 - allOf: - *253 - - *564 + - *574 + - allOf: + - *575 + - *574 - allOf: - *254 - - *564 + - *574 - allOf: - *255 - - *564 + - *574 - allOf: - *256 - - *564 + - *574 - allOf: - *257 - - *564 + - *574 - allOf: - *258 - - *564 + - *574 - allOf: - *259 - - *564 + - *574 - allOf: - *260 - - *564 + - *574 - allOf: - *261 - - *564 + - *574 - allOf: - *262 - - *564 + - *574 - allOf: - *263 - - *564 + - *574 - allOf: - *264 - - *564 + - *574 - allOf: - *265 - - *564 + - *574 - allOf: - *266 - - *564 + - *574 + - allOf: + - *267 + - *574 + - allOf: + - *268 + - *574 + - allOf: + - *269 + - *574 examples: default: value: @@ -84087,8 +85232,8 @@ paths: category: repos subcategory: rules parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 - name: includes_parents @@ -84099,7 +85244,7 @@ paths: schema: type: boolean default: true - - *566 + - *576 responses: '200': description: Response @@ -84107,7 +85252,7 @@ paths: application/json: schema: type: array - items: *267 + items: *270 examples: default: value: @@ -84138,7 +85283,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *97 + '500': *100 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -84154,8 +85299,8 @@ paths: category: repos subcategory: rules parameters: - - *304 - - *305 + - *309 + - *310 requestBody: description: Request body required: true @@ -84175,16 +85320,16 @@ paths: - tag - push default: branch - enforcement: *244 + enforcement: *247 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *245 - conditions: *242 + items: *248 + conditions: *245 rules: type: array description: An array of rules within the ruleset. - items: *567 + items: *577 required: - name - enforcement @@ -84215,9 +85360,9 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: &577 + default: &587 value: id: 42 name: super cool ruleset @@ -84250,7 +85395,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *97 + '500': *100 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -84264,12 +85409,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *304 - - *305 - - *568 - - *569 - - *570 - - *571 + - *309 + - *310 + - *578 + - *579 + - *580 + - *581 - *17 - *19 responses: @@ -84277,11 +85422,11 @@ paths: description: Response content: application/json: - schema: *572 + schema: *582 examples: - default: *573 + default: *583 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84300,19 +85445,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *304 - - *305 - - *574 + - *309 + - *310 + - *584 responses: '200': description: Response content: application/json: - schema: *575 + schema: *585 examples: - default: *576 + default: *586 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84338,8 +85483,8 @@ paths: category: repos subcategory: rules parameters: - - *304 - - *305 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84359,11 +85504,11 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: *577 + default: *587 '404': *6 - '500': *97 + '500': *100 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -84379,8 +85524,8 @@ paths: category: repos subcategory: rules parameters: - - *304 - - *305 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84405,16 +85550,16 @@ paths: - branch - tag - push - enforcement: *244 + enforcement: *247 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *245 - conditions: *242 + items: *248 + conditions: *245 rules: description: An array of rules within the ruleset. type: array - items: *567 + items: *577 examples: default: value: @@ -84442,11 +85587,11 @@ paths: description: Response content: application/json: - schema: *267 + schema: *270 examples: - default: *577 + default: *587 '404': *6 - '500': *97 + '500': *100 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -84462,8 +85607,8 @@ paths: category: repos subcategory: rules parameters: - - *304 - - *305 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84474,7 +85619,7 @@ paths: '204': description: Response '404': *6 - '500': *97 + '500': *100 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -84486,8 +85631,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 - name: ruleset_id @@ -84503,11 +85648,11 @@ paths: application/json: schema: type: array - items: *270 + items: *273 examples: - default: *578 + default: *588 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84524,8 +85669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *304 - - *305 + - *309 + - *310 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84543,7 +85688,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *589 examples: default: value: @@ -84576,7 +85721,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84598,21 +85743,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *304 - - *305 - - *271 - - *272 - - *273 + - *309 + - *310 - *274 - - *48 - - *19 - - *17 - - *580 - - *581 - *275 - *276 - *277 + - *48 + - *19 + - *17 + - *590 + - *591 - *278 + - *279 + - *280 + - *281 responses: '200': description: Response @@ -84620,7 +85765,7 @@ paths: application/json: schema: type: array - items: &585 + items: &595 type: object properties: number: *54 @@ -84639,8 +85784,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *582 - resolution: *583 + state: *592 + resolution: *593 resolved_at: type: string format: date-time @@ -84736,7 +85881,7 @@ paths: pull request. ' - oneOf: *584 + oneOf: *594 nullable: true has_more_locations: type: boolean @@ -84886,16 +86031,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *304 - - *305 - - *404 - - *278 + - *309 + - *310 + - *414 + - *281 responses: '200': description: Response content: application/json: - schema: *585 + schema: *595 examples: default: value: @@ -84947,9 +86092,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 requestBody: required: true content: @@ -84957,8 +86102,8 @@ paths: schema: type: object properties: - state: *582 - resolution: *583 + state: *592 + resolution: *593 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -84976,7 +86121,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *595 examples: default: value: @@ -85051,9 +86196,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *304 - - *305 - - *404 + - *309 + - *310 + - *414 - *19 - *17 responses: @@ -85064,7 +86209,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &739 + items: &751 type: object properties: type: @@ -85090,19 +86235,19 @@ paths: example: commit details: oneOf: - - *586 - - *587 - - *588 - - *589 - - *590 - - *591 - - *592 - - *593 - - *594 - - *595 - *596 - *597 - *598 + - *599 + - *600 + - *601 + - *602 + - *603 + - *604 + - *605 + - *606 + - *607 + - *608 examples: default: value: @@ -85188,8 +86333,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -85197,14 +86342,14 @@ paths: schema: type: object properties: - reason: &600 + reason: &610 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *599 + placeholder_id: *609 required: - reason - placeholder_id @@ -85221,7 +86366,7 @@ paths: schema: type: object properties: - reason: *600 + reason: *610 expire_at: type: string format: date-time @@ -85264,8 +86409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -85280,7 +86425,7 @@ paths: properties: incremental_scans: type: array - items: &601 + items: &611 description: Information on a single scan performed by secret scanning on the repository type: object @@ -85306,15 +86451,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *601 + items: *611 backfill_scans: type: array - items: *601 + items: *611 custom_pattern_backfill_scans: type: array items: allOf: - - *601 + - *611 - type: object properties: pattern_name: @@ -85384,8 +86529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *304 - - *305 + - *309 + - *310 - *48 - name: sort description: The property to sort the results by. @@ -85429,9 +86574,9 @@ paths: application/json: schema: type: array - items: *602 + items: *612 examples: - default: *603 + default: *613 '400': *14 '404': *6 x-github: @@ -85454,8 +86599,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -85528,7 +86673,7 @@ paths: login: type: string description: The username of the user credited. - type: *281 + type: *286 required: - login - type @@ -85615,9 +86760,9 @@ paths: description: Response content: application/json: - schema: *602 + schema: *612 examples: - default: &605 + default: &615 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -85850,8 +86995,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -85955,7 +87100,7 @@ paths: description: Response content: application/json: - schema: *602 + schema: *612 examples: default: value: @@ -86102,17 +87247,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *304 - - *305 - - *604 + - *309 + - *310 + - *614 responses: '200': description: Response content: application/json: - schema: *602 + schema: *612 examples: - default: *605 + default: *615 '403': *29 '404': *6 x-github: @@ -86136,9 +87281,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *304 - - *305 - - *604 + - *309 + - *310 + - *614 requestBody: required: true content: @@ -86211,7 +87356,7 @@ paths: login: type: string description: The username of the user credited. - type: *281 + type: *286 required: - login - type @@ -86297,17 +87442,17 @@ paths: description: Response content: application/json: - schema: *602 + schema: *612 examples: - default: *605 - add_credit: *605 + default: *615 + add_credit: *615 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *100 + schema: *103 examples: invalid_state_transition: value: @@ -86338,9 +87483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *304 - - *305 - - *604 + - *309 + - *310 + - *614 responses: '202': *39 '400': *14 @@ -86367,17 +87512,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *304 - - *305 - - *604 + - *309 + - *310 + - *614 responses: '202': description: Response content: application/json: - schema: *315 + schema: *320 examples: - default: *317 + default: *322 '400': *14 '422': *15 '403': *29 @@ -86403,8 +87548,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -86503,8 +87648,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -86513,7 +87658,7 @@ paths: application/json: schema: type: array - items: &606 + items: &616 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -86526,7 +87671,7 @@ paths: - 1124 - -435 '202': *39 - '204': *149 + '204': *152 '422': description: Repository contains more than 10,000 commits x-github: @@ -86546,8 +87691,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -86596,7 +87741,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *149 + '204': *152 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86623,8 +87768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -86698,7 +87843,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *149 + '204': *152 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86720,8 +87865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -86875,8 +88020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -86886,7 +88031,7 @@ paths: application/json: schema: type: array - items: *606 + items: *616 examples: default: value: @@ -86899,7 +88044,7 @@ paths: - - 0 - 2 - 21 - '204': *149 + '204': *152 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86919,8 +88064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *304 - - *305 + - *309 + - *310 - name: sha in: path required: true @@ -86974,7 +88119,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *617 examples: default: value: @@ -87028,8 +88173,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -87041,7 +88186,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -87061,14 +88206,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &608 + schema: &618 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -87136,8 +88281,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: false content: @@ -87163,7 +88308,7 @@ paths: description: Response content: application/json: - schema: *608 + schema: *618 examples: default: value: @@ -87190,8 +88335,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -87211,8 +88356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -87291,8 +88436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -87300,7 +88445,7 @@ paths: application/json: schema: type: array - items: &609 + items: &619 title: Tag protection description: Tag protection type: object @@ -87352,8 +88497,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -87376,7 +88521,7 @@ paths: description: Response content: application/json: - schema: *609 + schema: *619 examples: default: value: @@ -87407,8 +88552,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -87445,8 +88590,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *304 - - *305 + - *309 + - *310 - name: ref in: path required: true @@ -87482,8 +88627,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *304 - - *305 + - *309 + - *310 - *17 - *19 responses: @@ -87493,9 +88638,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *216 + default: *219 headers: Link: *58 '404': *6 @@ -87515,8 +88660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *304 - - *305 + - *309 + - *310 - *19 - *17 responses: @@ -87524,7 +88669,7 @@ paths: description: Response content: application/json: - schema: &610 + schema: &620 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -87536,7 +88681,7 @@ paths: required: - names examples: - default: &611 + default: &621 value: names: - octocat @@ -87559,8 +88704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -87591,9 +88736,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *620 examples: - default: *611 + default: *621 '404': *6 '422': *7 x-github: @@ -87614,9 +88759,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *304 - - *305 - - &612 + - *309 + - *310 + - &622 name: per description: The time frame to display results for. in: query @@ -87645,7 +88790,7 @@ paths: example: 128 clones: type: array - items: &613 + items: &623 title: Traffic type: object properties: @@ -87732,8 +88877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -87823,8 +88968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *304 - - *305 + - *309 + - *310 responses: '200': description: Response @@ -87884,9 +89029,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *304 - - *305 - - *612 + - *309 + - *310 + - *622 responses: '200': description: Response @@ -87905,7 +89050,7 @@ paths: example: 3782 views: type: array - items: *613 + items: *623 required: - uniques - count @@ -87982,8 +89127,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *304 - - *305 + - *309 + - *310 requestBody: required: true content: @@ -88019,7 +89164,7 @@ paths: description: Response content: application/json: - schema: *122 + schema: *125 examples: default: value: @@ -88257,8 +89402,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -88281,8 +89426,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -88304,8 +89449,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -88331,8 +89476,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *304 - - *305 + - *309 + - *310 - name: ref in: path required: true @@ -88424,9 +89569,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *320 examples: - default: *317 + default: *322 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -88467,7 +89612,7 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: default: value: @@ -88656,7 +89801,7 @@ paths: html_url: type: string format: uri - repository: *122 + repository: *125 score: type: number file_size: @@ -88674,7 +89819,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &614 + text_matches: &624 title: Search Result Text Matches type: array items: @@ -88836,7 +89981,7 @@ paths: enum: - author-date - committer-date - - &615 + - &625 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -88907,7 +90052,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *370 + properties: *380 nullable: true comment_count: type: integer @@ -88927,7 +90072,7 @@ paths: url: type: string format: uri - verification: *487 + verification: *497 required: - author - committer @@ -88946,7 +90091,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *370 + properties: *380 nullable: true parents: type: array @@ -88959,12 +90104,12 @@ paths: type: string sha: type: string - repository: *122 + repository: *125 score: type: number node_id: type: string - text_matches: *614 + text_matches: *624 required: - sha - node_id @@ -89146,7 +90291,7 @@ paths: - interactions - created - updated - - *615 + - *625 - *17 - *19 - name: advanced_search @@ -89243,7 +90388,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: type: string state_reason: @@ -89260,8 +90406,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *439 - required: *440 + properties: *449 + required: *450 nullable: true comments: type: integer @@ -89275,7 +90421,7 @@ paths: type: string format: date-time nullable: true - text_matches: *614 + text_matches: *624 pull_request: type: object properties: @@ -89319,7 +90465,7 @@ paths: timeline_url: type: string format: uri - type: *196 + type: *199 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -89503,7 +90649,7 @@ paths: enum: - created - updated - - *615 + - *625 - *17 - *19 responses: @@ -89547,7 +90693,7 @@ paths: nullable: true score: type: number - text_matches: *614 + text_matches: *624 required: - id - node_id @@ -89632,7 +90778,7 @@ paths: - forks - help-wanted-issues - updated - - *615 + - *625 - *17 - *19 responses: @@ -89871,7 +91017,7 @@ paths: - admin - pull - push - text_matches: *614 + text_matches: *624 temp_clone_token: type: string allow_merge_commit: @@ -90171,7 +91317,7 @@ paths: type: string format: uri nullable: true - text_matches: *614 + text_matches: *624 related: type: array nullable: true @@ -90362,7 +91508,7 @@ paths: - followers - repositories - joined - - *615 + - *625 - *17 - *19 responses: @@ -90466,7 +91612,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *614 + text_matches: *624 blog: type: string nullable: true @@ -90545,7 +91691,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &617 + - &628 name: team_id description: The unique identifier of the team. in: path @@ -90557,9 +91703,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '404': *6 x-github: githubCloudOnly: false @@ -90586,7 +91732,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *617 + - *628 requestBody: required: true content: @@ -90649,16 +91795,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '201': description: Response content: application/json: - schema: *289 + schema: *294 examples: - default: *290 + default: *295 '404': *6 '422': *15 '403': *29 @@ -90686,7 +91832,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *617 + - *628 responses: '204': description: Response @@ -90717,7 +91863,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *617 + - *628 - *48 - *17 - *19 @@ -90728,9 +91874,9 @@ paths: application/json: schema: type: array - items: *291 + items: *296 examples: - default: *618 + default: *629 headers: Link: *58 x-github: @@ -90759,7 +91905,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *617 + - *628 requestBody: required: true content: @@ -90793,9 +91939,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *292 + default: *297 x-github: triggersNotification: true githubCloudOnly: false @@ -90822,16 +91968,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *617 - - *293 + - *628 + - *298 responses: '200': description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *292 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90856,8 +92002,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *617 - - *293 + - *628 + - *298 requestBody: required: false content: @@ -90880,9 +92026,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *296 examples: - default: *619 + default: *630 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90907,8 +92053,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *617 - - *293 + - *628 + - *298 responses: '204': description: Response @@ -90937,8 +92083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *617 - - *293 + - *628 + - *298 - *48 - *17 - *19 @@ -90949,9 +92095,9 @@ paths: application/json: schema: type: array - items: *294 + items: *299 examples: - default: *620 + default: *631 headers: Link: *58 x-github: @@ -90980,8 +92126,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *617 - - *293 + - *628 + - *298 requestBody: required: true content: @@ -91003,9 +92149,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: *295 + default: *300 x-github: triggersNotification: true githubCloudOnly: false @@ -91032,17 +92178,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *617 - - *293 - - *296 + - *628 + - *298 + - *301 responses: '200': description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: *295 + default: *300 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91067,9 +92213,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *617 - - *293 - - *296 + - *628 + - *298 + - *301 requestBody: required: true content: @@ -91091,9 +92237,9 @@ paths: description: Response content: application/json: - schema: *294 + schema: *299 examples: - default: *621 + default: *632 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91118,9 +92264,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *617 - - *293 - - *296 + - *628 + - *298 + - *301 responses: '204': description: Response @@ -91149,9 +92295,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *617 - - *293 - - *296 + - *628 + - *298 + - *301 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -91177,9 +92323,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 x-github: @@ -91208,9 +92354,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *617 - - *293 - - *296 + - *628 + - *298 + - *301 requestBody: required: true content: @@ -91242,9 +92388,9 @@ paths: description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91270,8 +92416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *617 - - *293 + - *628 + - *298 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -91297,9 +92443,9 @@ paths: application/json: schema: type: array - items: *297 + items: *302 examples: - default: *299 + default: *304 headers: Link: *58 x-github: @@ -91328,8 +92474,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *617 - - *293 + - *628 + - *298 requestBody: required: true content: @@ -91361,9 +92507,9 @@ paths: description: Response content: application/json: - schema: *297 + schema: *302 examples: - default: *298 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -91387,7 +92533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *617 + - *628 - *17 - *19 responses: @@ -91397,9 +92543,9 @@ paths: application/json: schema: type: array - items: *193 + items: *196 examples: - default: *194 + default: *197 headers: Link: *58 x-github: @@ -91425,7 +92571,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *617 + - *628 - name: role description: Filters members returned by their role in the team. in: query @@ -91448,7 +92594,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '404': *6 @@ -91476,8 +92622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *617 - - *135 + - *628 + - *138 responses: '204': description: if user is a member @@ -91513,8 +92659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *617 - - *135 + - *628 + - *138 responses: '204': description: Response @@ -91553,8 +92699,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *617 - - *135 + - *628 + - *138 responses: '204': description: Response @@ -91590,16 +92736,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *617 - - *135 + - *628 + - *138 responses: '200': description: Response content: application/json: - schema: *301 + schema: *306 examples: - response-if-user-is-a-team-maintainer: *622 + response-if-user-is-a-team-maintainer: *633 '404': *6 x-github: githubCloudOnly: false @@ -91632,8 +92778,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *617 - - *135 + - *628 + - *138 requestBody: required: false content: @@ -91658,9 +92804,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *306 examples: - response-if-users-membership-with-team-is-now-pending: *623 + response-if-users-membership-with-team-is-now-pending: *634 '403': description: Forbidden if team synchronization is set up '422': @@ -91694,8 +92840,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *617 - - *135 + - *628 + - *138 responses: '204': description: Response @@ -91723,7 +92869,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *617 + - *628 - *17 - *19 responses: @@ -91733,9 +92879,9 @@ paths: application/json: schema: type: array - items: *302 + items: *307 examples: - default: *624 + default: *635 headers: Link: *58 '404': *6 @@ -91761,16 +92907,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *617 - - *303 + - *628 + - *308 responses: '200': description: Response content: application/json: - schema: *302 + schema: *307 examples: - default: *625 + default: *636 '404': description: Not Found if project is not managed by this team x-github: @@ -91794,8 +92940,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *617 - - *303 + - *628 + - *308 requestBody: required: false content: @@ -91862,8 +93008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *617 - - *303 + - *628 + - *308 responses: '204': description: Response @@ -91890,7 +93036,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *617 + - *628 - *17 - *19 responses: @@ -91900,9 +93046,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 '404': *6 @@ -91932,15 +93078,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *617 - - *304 - - *305 + - *628 + - *309 + - *310 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *626 + schema: *637 examples: alternative-response-with-extra-repository-information: value: @@ -92091,9 +93237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *617 - - *304 - - *305 + - *628 + - *309 + - *310 requestBody: required: false content: @@ -92143,9 +93289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *617 - - *304 - - *305 + - *628 + - *309 + - *310 responses: '204': description: Response @@ -92170,7 +93316,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *617 + - *628 - *17 - *19 responses: @@ -92180,9 +93326,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - response-if-child-teams-exist: *627 + response-if-child-teams-exist: *638 headers: Link: *58 '404': *6 @@ -92215,7 +93361,7 @@ paths: application/json: schema: oneOf: - - &629 + - &640 title: Private User description: Private User type: object @@ -92418,7 +93564,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *628 + - *639 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -92571,7 +93717,7 @@ paths: description: Response content: application/json: - schema: *629 + schema: *640 examples: default: value: @@ -92650,7 +93796,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '304': *37 '404': *6 '403': *29 @@ -92673,7 +93819,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *135 + - *138 responses: '204': description: If the user is blocked @@ -92701,7 +93847,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *135 + - *138 responses: '204': description: Response @@ -92725,7 +93871,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *135 + - *138 responses: '204': description: Response @@ -92774,11 +93920,11 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: - default: *203 + default: *206 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -92915,17 +94061,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '401': *25 '403': *29 '404': *6 @@ -92969,7 +94115,7 @@ paths: type: integer secrets: type: array - items: &630 + items: &641 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -93009,7 +94155,7 @@ paths: - visibility - selected_repositories_url examples: - default: *427 + default: *437 headers: Link: *58 x-github: @@ -93079,13 +94225,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *130 + - *133 responses: '200': description: Response content: application/json: - schema: *630 + schema: *641 examples: default: value: @@ -93115,7 +94261,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *130 + - *133 requestBody: required: true content: @@ -93160,7 +94306,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -93188,7 +94334,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *130 + - *133 responses: '204': description: Response @@ -93213,7 +94359,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *130 + - *133 responses: '200': description: Response @@ -93229,13 +94375,13 @@ paths: type: integer repositories: type: array - items: *122 + items: *125 examples: - default: *631 + default: *642 '401': *25 '403': *29 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93256,7 +94402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *130 + - *133 requestBody: required: true content: @@ -93288,7 +94434,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93310,7 +94456,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *130 + - *133 - name: repository_id in: path required: true @@ -93322,7 +94468,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93343,7 +94489,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *130 + - *133 - name: repository_id in: path required: true @@ -93355,7 +94501,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *97 + '500': *100 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93375,17 +94521,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -93409,7 +94555,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 requestBody: required: false content: @@ -93439,9 +94585,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '401': *25 '403': *29 '404': *6 @@ -93463,11 +94609,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: '202': *39 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -93492,13 +94638,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: '202': description: Response content: application/json: - schema: &632 + schema: &643 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -93539,7 +94685,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &633 + default: &644 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -93547,7 +94693,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -93571,7 +94717,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *204 + - *207 - name: export_id in: path required: true @@ -93584,9 +94730,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *643 examples: - default: *633 + default: *644 '404': *6 x-github: githubCloudOnly: false @@ -93607,7 +94753,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *204 + - *207 responses: '200': description: Response @@ -93623,11 +94769,11 @@ paths: type: integer machines: type: array - items: *634 + items: *645 examples: - default: *635 + default: *646 '304': *37 - '500': *97 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -93654,7 +94800,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *204 + - *207 requestBody: required: true content: @@ -93704,13 +94850,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *315 + repository: *320 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *425 - required: *426 + properties: *435 + required: *436 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -94484,17 +95630,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *424 + default: *434 '304': *37 - '500': *97 + '500': *100 '400': *14 '401': *25 '402': @@ -94524,16 +95670,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *424 - '500': *97 + default: *434 + '500': *100 '401': *25 '403': *29 '404': *6 @@ -94562,9 +95708,9 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: &648 + default: &658 value: - id: 197 name: hello_docker @@ -94665,7 +95811,7 @@ paths: application/json: schema: type: array - items: &636 + items: &647 title: Email description: Email type: object @@ -94730,9 +95876,9 @@ paths: application/json: schema: type: array - items: *636 + items: *647 examples: - default: &650 + default: &660 value: - email: octocat@github.com verified: true @@ -94807,7 +95953,7 @@ paths: application/json: schema: type: array - items: *636 + items: *647 examples: default: value: @@ -94917,7 +96063,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '304': *37 @@ -94950,7 +96096,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 '304': *37 @@ -94972,7 +96118,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *135 + - *138 responses: '204': description: if the person is followed by the authenticated user @@ -95002,7 +96148,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *135 + - *138 responses: '204': description: Response @@ -95027,7 +96173,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *135 + - *138 responses: '204': description: Response @@ -95063,7 +96209,7 @@ paths: application/json: schema: type: array - items: &637 + items: &648 title: GPG Key description: A unique encryption key type: object @@ -95194,7 +96340,7 @@ paths: - subkeys - revoked examples: - default: &664 + default: &674 value: - id: 3 name: Octocat's GPG Key @@ -95279,9 +96425,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *648 examples: - default: &638 + default: &649 value: id: 3 name: Octocat's GPG Key @@ -95338,7 +96484,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &639 + - &650 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -95350,9 +96496,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *648 examples: - default: *638 + default: *649 '404': *6 '304': *37 '403': *29 @@ -95375,7 +96521,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *639 + - *650 responses: '204': description: Response @@ -95566,7 +96712,7 @@ paths: type: array items: *60 examples: - default: *640 + default: *115 headers: Link: *58 '404': *6 @@ -95591,7 +96737,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *112 + - *97 responses: '204': description: Response @@ -95617,7 +96763,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *112 + - *97 responses: '204': description: Response @@ -95651,12 +96797,12 @@ paths: application/json: schema: anyOf: - - *191 + - *194 - type: object properties: {} additionalProperties: false examples: - default: *192 + default: *195 '204': description: Response when there are no restrictions x-github: @@ -95680,7 +96826,7 @@ paths: required: true content: application/json: - schema: *498 + schema: *508 examples: default: value: @@ -95691,7 +96837,7 @@ paths: description: Response content: application/json: - schema: *191 + schema: *194 examples: default: value: @@ -95772,7 +96918,7 @@ paths: - closed - all default: open - - *199 + - *202 - name: sort description: What to sort results by. in: query @@ -95797,7 +96943,7 @@ paths: type: array items: *77 examples: - default: *200 + default: *203 headers: Link: *58 '404': *6 @@ -95830,7 +96976,7 @@ paths: application/json: schema: type: array - items: &641 + items: &651 title: Key description: Key type: object @@ -95931,9 +97077,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *651 examples: - default: &642 + default: &652 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -95966,15 +97112,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *527 + - *537 responses: '200': description: Response content: application/json: - schema: *641 + schema: *651 examples: - default: *642 + default: *652 '404': *6 '304': *37 '403': *29 @@ -95997,7 +97143,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *527 + - *537 responses: '204': description: Response @@ -96030,7 +97176,7 @@ paths: application/json: schema: type: array - items: &643 + items: &653 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -96098,7 +97244,7 @@ paths: - account - plan examples: - default: &644 + default: &654 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -96160,9 +97306,9 @@ paths: application/json: schema: type: array - items: *643 + items: *653 examples: - default: *644 + default: *654 headers: Link: *58 '304': *37 @@ -96202,7 +97348,7 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: default: value: @@ -96304,13 +97450,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *96 + - *94 responses: '200': description: Response content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -96368,7 +97514,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *96 + - *94 requestBody: required: true content: @@ -96393,7 +97539,7 @@ paths: description: Response content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -96461,7 +97607,7 @@ paths: application/json: schema: type: array - items: *209 + items: *212 examples: default: value: @@ -96714,7 +97860,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -96894,7 +98040,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *210 + - *213 - name: exclude in: query required: false @@ -96907,7 +98053,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -97101,7 +98247,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *210 + - *213 responses: '302': description: Response @@ -97127,7 +98273,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *210 + - *213 responses: '204': description: Response @@ -97156,8 +98302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *210 - - *645 + - *213 + - *655 responses: '204': description: Response @@ -97181,7 +98327,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *210 + - *213 - *17 - *19 responses: @@ -97191,9 +98337,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 '404': *6 @@ -97228,9 +98374,9 @@ paths: application/json: schema: type: array - items: *206 + items: *209 examples: - default: *646 + default: *656 headers: Link: *58 '304': *37 @@ -97272,7 +98418,7 @@ paths: - docker - nuget - container - - *647 + - *657 - *19 - *17 responses: @@ -97282,10 +98428,10 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: *648 - '400': *649 + default: *658 + '400': *659 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97305,16 +98451,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *219 - - *220 + - *222 + - *223 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: &665 + default: &675 value: id: 40201 name: octo-name @@ -97427,8 +98573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *219 - - *220 + - *222 + - *223 responses: '204': description: Response @@ -97458,8 +98604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *219 - - *220 + - *222 + - *223 - name: token description: package token schema: @@ -97491,8 +98637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *219 - - *220 + - *222 + - *223 - *19 - *17 - name: state @@ -97512,7 +98658,7 @@ paths: application/json: schema: type: array - items: *221 + items: *224 examples: default: value: @@ -97561,15 +98707,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *219 - - *220 - *222 + - *223 + - *225 responses: '200': description: Response content: application/json: - schema: *221 + schema: *224 examples: default: value: @@ -97605,9 +98751,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *219 - - *220 - *222 + - *223 + - *225 responses: '204': description: Response @@ -97637,9 +98783,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *219 - - *220 - *222 + - *223 + - *225 responses: '204': description: Response @@ -97695,7 +98841,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: default: value: @@ -97767,9 +98913,9 @@ paths: application/json: schema: type: array - items: *636 + items: *647 examples: - default: *650 + default: *660 headers: Link: *58 '304': *37 @@ -97882,7 +99028,7 @@ paths: type: array items: *60 examples: - default: &657 + default: &667 summary: Default response value: - id: 1296269 @@ -98186,9 +99332,9 @@ paths: description: Response content: application/json: - schema: *315 + schema: *320 examples: - default: *317 + default: *322 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -98226,9 +99372,9 @@ paths: application/json: schema: type: array - items: *500 + items: *510 examples: - default: *651 + default: *661 headers: Link: *58 '304': *37 @@ -98251,7 +99397,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *195 + - *198 responses: '204': description: Response @@ -98274,7 +99420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *195 + - *198 responses: '204': description: Response @@ -98307,7 +99453,7 @@ paths: application/json: schema: type: array - items: &652 + items: &662 title: Social account description: Social media account type: object @@ -98322,7 +99468,7 @@ paths: - provider - url examples: - default: &653 + default: &663 value: - provider: twitter url: https://twitter.com/github @@ -98384,9 +99530,9 @@ paths: application/json: schema: type: array - items: *652 + items: *662 examples: - default: *653 + default: *663 '422': *15 '304': *37 '404': *6 @@ -98473,7 +99619,7 @@ paths: application/json: schema: type: array - items: &654 + items: &664 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -98493,7 +99639,7 @@ paths: - title - created_at examples: - default: &676 + default: &686 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -98559,9 +99705,9 @@ paths: description: Response content: application/json: - schema: *654 + schema: *664 examples: - default: &655 + default: &665 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -98592,7 +99738,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &656 + - &666 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -98604,9 +99750,9 @@ paths: description: Response content: application/json: - schema: *654 + schema: *664 examples: - default: *655 + default: *665 '404': *6 '304': *37 '403': *29 @@ -98629,7 +99775,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *656 + - *666 responses: '204': description: Response @@ -98658,7 +99804,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &677 + - &687 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -98683,11 +99829,11 @@ paths: type: array items: *60 examples: - default-response: *657 + default-response: *667 application/vnd.github.v3.star+json: schema: type: array - items: &678 + items: &688 title: Starred Repository description: Starred Repository type: object @@ -98843,8 +99989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response if this repository is starred by you @@ -98872,8 +100018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -98897,8 +100043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *304 - - *305 + - *309 + - *310 responses: '204': description: Response @@ -98931,9 +100077,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 '304': *37 @@ -98970,7 +100116,7 @@ paths: application/json: schema: type: array - items: *289 + items: *294 examples: default: value: @@ -99056,10 +100202,10 @@ paths: application/json: schema: oneOf: - - *629 - - *628 + - *640 + - *639 examples: - default-response: &659 + default-response: &669 summary: Default response value: login: octocat @@ -99094,7 +100240,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &660 + response-with-git-hub-plan-information: &670 summary: Response with GitHub plan information value: login: octocat @@ -99154,7 +100300,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *658 + - *668 - *17 responses: '200': @@ -99165,7 +100311,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: example: ; rel="next" @@ -99195,7 +100341,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *135 + - *138 responses: '200': description: Response @@ -99203,11 +100349,11 @@ paths: application/json: schema: oneOf: - - *629 - - *628 + - *640 + - *639 examples: - default-response: *659 - response-with-git-hub-plan-information: *660 + default-response: *669 + response-with-git-hub-plan-information: *670 '404': *6 x-github: githubCloudOnly: false @@ -99233,7 +100379,7 @@ paths: - *17 - *40 - *41 - - *135 + - *138 requestBody: required: true content: @@ -99256,8 +100402,8 @@ paths: required: - subject_digests examples: - default: *661 - withPredicateType: *662 + default: *671 + withPredicateType: *672 responses: '200': description: Response @@ -99310,7 +100456,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *663 + default: *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -99328,7 +100474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *135 + - *138 requestBody: required: true content: @@ -99393,7 +100539,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *135 + - *138 - name: subject_digest description: Subject Digest in: path @@ -99424,7 +100570,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *135 + - *138 - name: attestation_id description: Attestation ID in: path @@ -99462,7 +100608,7 @@ paths: - *17 - *40 - *41 - - *135 + - *138 - name: subject_digest description: Subject Digest in: path @@ -99512,12 +100658,12 @@ paths: bundle_url: type: string examples: - default: *366 + default: *376 '201': description: Response content: application/json: - schema: *131 + schema: *134 examples: default: value: @@ -99543,7 +100689,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *135 + - *138 responses: '200': description: Response @@ -99551,9 +100697,9 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: *648 + default: *658 '403': *29 '401': *25 x-github: @@ -99576,7 +100722,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -99657,8 +100803,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *135 - - *96 + - *138 + - *94 - *17 - *19 responses: @@ -99747,7 +100893,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -99824,7 +100970,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -99836,7 +100982,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -99855,7 +101001,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *135 + - *138 - *17 - *19 responses: @@ -99867,7 +101013,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *58 x-github: @@ -99886,7 +101032,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *135 + - *138 - name: target_user in: path required: true @@ -99913,7 +101059,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *135 + - *138 - *67 - *17 - *19 @@ -99947,7 +101093,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -99957,9 +101103,9 @@ paths: application/json: schema: type: array - items: *637 + items: *648 examples: - default: *664 + default: *674 headers: Link: *58 x-github: @@ -99983,7 +101129,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *135 + - *138 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -100055,7 +101201,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *135 + - *138 responses: '200': description: Response @@ -100063,7 +101209,7 @@ paths: application/json: schema: *22 examples: - default: *497 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100081,7 +101227,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -100136,7 +101282,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -100146,9 +101292,9 @@ paths: application/json: schema: type: array - items: *206 + items: *209 examples: - default: *646 + default: *656 headers: Link: *58 x-github: @@ -100187,8 +101333,8 @@ paths: - docker - nuget - container - - *647 - - *135 + - *657 + - *138 - *19 - *17 responses: @@ -100198,12 +101344,12 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: *648 + default: *658 '403': *29 '401': *25 - '400': *649 + '400': *659 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100223,17 +101369,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *219 - - *220 - - *135 + - *222 + - *223 + - *138 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: *665 + default: *675 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100254,9 +101400,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *219 - - *220 - - *135 + - *222 + - *223 + - *138 responses: '204': description: Response @@ -100288,9 +101434,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *219 - - *220 - - *135 + - *222 + - *223 + - *138 - name: token description: package token schema: @@ -100322,9 +101468,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *219 - - *220 - - *135 + - *222 + - *223 + - *138 responses: '200': description: Response @@ -100332,7 +101478,7 @@ paths: application/json: schema: type: array - items: *221 + items: *224 examples: default: value: @@ -100390,16 +101536,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *219 - - *220 - *222 - - *135 + - *223 + - *225 + - *138 responses: '200': description: Response content: application/json: - schema: *221 + schema: *224 examples: default: value: @@ -100434,10 +101580,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *219 - - *220 - - *135 - *222 + - *223 + - *138 + - *225 responses: '204': description: Response @@ -100469,10 +101615,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *219 - - *220 - - *135 - *222 + - *223 + - *138 + - *225 responses: '204': description: Response @@ -100498,7 +101644,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects-classic/projects#list-user-projects parameters: - - *135 + - *138 - name: state description: Indicates the state of the projects to return. in: query @@ -100519,7 +101665,7 @@ paths: application/json: schema: type: array - items: *233 + items: *236 examples: default: value: @@ -100581,7 +101727,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -100670,7 +101816,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -100757,7 +101903,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *135 + - *138 - name: type description: Limit results to repositories of the specified type. in: query @@ -100800,9 +101946,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -100826,15 +101972,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *135 + - *138 responses: '200': description: Response content: application/json: - schema: *666 + schema: *676 examples: - default: *667 + default: *677 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100856,15 +102002,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *135 + - *138 responses: '200': description: Response content: application/json: - schema: *668 + schema: *678 examples: - default: *669 + default: *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100886,15 +102032,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *135 + - *138 responses: '200': description: Response content: application/json: - schema: *670 + schema: *680 examples: - default: *671 + default: *681 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100914,11 +102060,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *135 - - *672 - - *673 - - *674 - - *675 + - *138 + - *682 + - *683 + - *684 + - *685 responses: '200': description: Response when getting a billing usage report @@ -100988,7 +102134,7 @@ paths: repositoryName: user/example '400': *14 '403': *29 - '500': *97 + '500': *100 '503': *65 x-github: githubCloudOnly: false @@ -101007,7 +102153,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -101017,9 +102163,9 @@ paths: application/json: schema: type: array - items: *652 + items: *662 examples: - default: *653 + default: *663 headers: Link: *58 x-github: @@ -101039,7 +102185,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -101049,9 +102195,9 @@ paths: application/json: schema: type: array - items: *654 + items: *664 examples: - default: *676 + default: *686 headers: Link: *58 x-github: @@ -101075,8 +102221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *135 - - *677 + - *138 + - *687 - *48 - *17 - *19 @@ -101088,11 +102234,11 @@ paths: schema: anyOf: - type: array - items: *678 + items: *688 - type: array items: *60 examples: - default-response: *657 + default-response: *667 headers: Link: *58 x-github: @@ -101111,7 +102257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *135 + - *138 - *17 - *19 responses: @@ -101121,9 +102267,9 @@ paths: application/json: schema: type: array - items: *122 + items: *125 examples: - default: *223 + default: *226 headers: Link: *58 x-github: @@ -101251,7 +102397,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &679 + enterprise: &689 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -101309,7 +102455,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &680 + installation: &690 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -101328,7 +102474,7 @@ x-webhooks: required: - id - node_id - organization: &681 + organization: &691 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -101388,13 +102534,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &682 + repository: &692 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &712 + properties: &722 id: description: Unique identifier of the repository example: 42 @@ -102077,7 +103223,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &713 + required: &723 - archive_url - assignees_url - blobs_url @@ -102228,10 +103374,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -102307,11 +103453,11 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - rule: &683 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + rule: &693 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -102534,11 +103680,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - rule: *683 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + rule: *693 sender: *4 required: - action @@ -102721,11 +103867,11 @@ x-webhooks: - everyone required: - from - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - rule: *683 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + rule: *693 sender: *4 required: - action @@ -102809,7 +103955,7 @@ x-webhooks: type: string enum: - completed - check_run: &685 + check_run: &695 title: CheckRun description: A check performed on the code of a given code change type: object @@ -102862,8 +104008,8 @@ x-webhooks: type: string pull_requests: type: array - items: *383 - repository: *122 + items: *393 + repository: *125 status: example: completed type: string @@ -102900,7 +104046,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *684 + deployment: *694 details_url: example: https://example.com type: string @@ -102950,7 +104096,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *383 + items: *393 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -102985,9 +104131,9 @@ x-webhooks: - output - app - pull_requests - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - check_run @@ -103380,10 +104526,10 @@ x-webhooks: type: string enum: - created - check_run: *685 - installation: *680 - organization: *681 - repository: *682 + check_run: *695 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - check_run @@ -103779,10 +104925,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *685 - installation: *680 - organization: *681 - repository: *682 + check_run: *695 + installation: *690 + organization: *691 + repository: *692 requested_action: description: The action requested by the user. type: object @@ -104187,10 +105333,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *685 - installation: *680 - organization: *681 - repository: *682 + check_run: *695 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - check_run @@ -105167,10 +106313,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -105840,10 +106986,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -106507,10 +107653,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -106673,7 +107819,7 @@ x-webhooks: required: - login - id - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -106818,20 +107964,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &686 + commit_oid: &696 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *679 - installation: *680 - organization: *681 - ref: &687 + enterprise: *689 + installation: *690 + organization: *691 + ref: &697 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *682 + repository: *692 sender: *4 required: - action @@ -106993,7 +108139,7 @@ x-webhooks: required: - login - id - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -107223,12 +108369,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *686 - enterprise: *679 - installation: *680 - organization: *681 - ref: *687 - repository: *682 + commit_oid: *696 + enterprise: *689 + installation: *690 + organization: *691 + ref: *697 + repository: *692 sender: *4 required: - action @@ -107323,7 +108469,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -107491,12 +108637,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *686 - enterprise: *679 - installation: *680 - organization: *681 - ref: *687 - repository: *682 + commit_oid: *696 + enterprise: *689 + installation: *690 + organization: *691 + ref: *697 + repository: *692 sender: *4 required: - action @@ -107659,7 +108805,7 @@ x-webhooks: required: - login - id - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -107825,12 +108971,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *686 - enterprise: *679 - installation: *680 - organization: *681 - ref: *687 - repository: *682 + commit_oid: *696 + enterprise: *689 + installation: *690 + organization: *691 + ref: *697 + repository: *692 sender: *4 required: - action @@ -107927,7 +109073,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -108095,16 +109241,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *682 + repository: *692 sender: *4 required: - action @@ -108198,7 +109344,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *399 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -108338,12 +109484,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *686 - enterprise: *679 - installation: *680 - organization: *681 - ref: *687 - repository: *682 + commit_oid: *696 + enterprise: *689 + installation: *690 + organization: *691 + ref: *697 + repository: *692 sender: *4 required: - action @@ -108600,10 +109746,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -108683,18 +109829,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *681 - pusher_type: &688 + organization: *691 + pusher_type: &698 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &689 + ref: &699 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -108704,7 +109850,7 @@ x-webhooks: enum: - tag - branch - repository: *682 + repository: *692 sender: *4 required: - ref @@ -108786,10 +109932,10 @@ x-webhooks: type: string enum: - created - definition: *234 - enterprise: *679 - installation: *680 - organization: *681 + definition: *237 + enterprise: *689 + installation: *690 + organization: *691 sender: *4 required: - action @@ -108874,9 +110020,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 sender: *4 required: - action @@ -108953,10 +110099,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *234 - enterprise: *679 - installation: *680 - organization: *681 + definition: *237 + enterprise: *689 + installation: *690 + organization: *691 sender: *4 required: - action @@ -109033,10 +110179,10 @@ x-webhooks: type: string enum: - updated - definition: *234 - enterprise: *679 - installation: *680 - organization: *681 + definition: *237 + enterprise: *689 + installation: *690 + organization: *691 sender: *4 required: - action @@ -109113,19 +110259,19 @@ x-webhooks: type: string enum: - updated - enterprise: *679 - installation: *680 - repository: *682 - organization: *681 + enterprise: *689 + installation: *690 + repository: *692 + organization: *691 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *238 + items: *241 old_property_values: type: array description: The old custom property values for the repository. - items: *238 + items: *241 required: - action - repository @@ -109201,18 +110347,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *679 - installation: *680 - organization: *681 - pusher_type: *688 - ref: *689 + enterprise: *689 + installation: *690 + organization: *691 + pusher_type: *698 + ref: *699 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *682 + repository: *692 sender: *4 required: - ref @@ -109296,11 +110442,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109384,11 +110530,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109472,11 +110618,11 @@ x-webhooks: type: string enum: - created - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109558,11 +110704,11 @@ x-webhooks: type: string enum: - dismissed - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109644,11 +110790,11 @@ x-webhooks: type: string enum: - fixed - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109731,11 +110877,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109817,11 +110963,11 @@ x-webhooks: type: string enum: - reopened - alert: *456 - installation: *680 - organization: *681 - enterprise: *679 - repository: *682 + alert: *466 + installation: *690 + organization: *691 + enterprise: *689 + repository: *692 sender: *4 required: - action @@ -109898,9 +111044,9 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - key: &690 + enterprise: *689 + installation: *690 + key: &700 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -109936,8 +111082,8 @@ x-webhooks: - verified - created_at - read_only - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -110014,11 +111160,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - key: *690 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + key: *700 + organization: *691 + repository: *692 sender: *4 required: - action @@ -110579,12 +111725,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - workflow: &694 + workflow: &704 title: Workflow type: object nullable: true @@ -111310,13 +112456,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *462 + deployment: *472 pull_requests: type: array - items: *547 - repository: *682 - organization: *681 - installation: *680 + items: *557 + repository: *692 + organization: *691 + installation: *690 sender: *4 responses: '200': @@ -111387,7 +112533,7 @@ x-webhooks: type: string enum: - approved - approver: &691 + approver: &701 type: object properties: avatar_url: @@ -111430,11 +112576,11 @@ x-webhooks: type: string comment: type: string - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - reviewers: &692 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + reviewers: &702 type: array items: type: object @@ -111513,7 +112659,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &693 + workflow_job_run: &703 type: object properties: conclusion: @@ -112244,18 +113390,18 @@ x-webhooks: type: string enum: - rejected - approver: *691 + approver: *701 comment: type: string - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - reviewers: *692 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + reviewers: *702 sender: *4 since: type: string - workflow_job_run: *693 + workflow_job_run: *703 workflow_job_runs: type: array items: @@ -112959,13 +114105,13 @@ x-webhooks: type: string enum: - requested - enterprise: *679 + enterprise: *689 environment: type: string - installation: *680 - organization: *681 - repository: *682 - requestor: &699 + installation: *690 + organization: *691 + repository: *692 + requestor: &709 title: User type: object nullable: true @@ -114864,12 +116010,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - workflow: *694 + workflow: *704 workflow_run: title: Deployment Workflow Run type: object @@ -115549,7 +116695,7 @@ x-webhooks: type: string enum: - answered - answer: &697 + answer: &707 type: object properties: author_association: @@ -115706,7 +116852,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &695 + discussion: &705 title: Discussion description: A Discussion in a repository. type: object @@ -115992,7 +117138,7 @@ x-webhooks: - id labels: type: array - items: *509 + items: *520 required: - repository_url - category @@ -116014,10 +117160,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116144,11 +117290,11 @@ x-webhooks: - from required: - category - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116231,11 +117377,11 @@ x-webhooks: type: string enum: - closed - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116317,7 +117463,7 @@ x-webhooks: type: string enum: - created - comment: &696 + comment: &706 type: object properties: author_association: @@ -116474,11 +117620,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116561,12 +117707,12 @@ x-webhooks: type: string enum: - deleted - comment: *696 - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + comment: *706 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116661,12 +117807,12 @@ x-webhooks: - from required: - body - comment: *696 - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + comment: *706 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116750,11 +117896,11 @@ x-webhooks: type: string enum: - created - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116836,11 +117982,11 @@ x-webhooks: type: string enum: - deleted - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -116940,11 +118086,11 @@ x-webhooks: type: string required: - from - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117026,10 +118172,10 @@ x-webhooks: type: string enum: - labeled - discussion: *695 - enterprise: *679 - installation: *680 - label: &698 + discussion: *705 + enterprise: *689 + installation: *690 + label: &708 title: Label type: object properties: @@ -117061,8 +118207,8 @@ x-webhooks: - color - default - description - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117145,11 +118291,11 @@ x-webhooks: type: string enum: - locked - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117231,11 +118377,11 @@ x-webhooks: type: string enum: - pinned - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117317,11 +118463,11 @@ x-webhooks: type: string enum: - reopened - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117406,16 +118552,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *695 - new_repository: *682 + new_discussion: *705 + new_repository: *692 required: - new_discussion - new_repository - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117498,10 +118644,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *695 - old_answer: *697 - organization: *681 - repository: *682 + discussion: *705 + old_answer: *707 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117583,12 +118729,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *695 - enterprise: *679 - installation: *680 - label: *698 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117671,11 +118817,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117757,11 +118903,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *695 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + discussion: *705 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -117834,7 +118980,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *679 + enterprise: *689 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -118494,9 +119640,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - forkee @@ -118642,9 +119788,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pages: description: The pages that were updated. type: array @@ -118681,7 +119827,7 @@ x-webhooks: - action - sha - html_url - repository: *682 + repository: *692 sender: *4 required: - pages @@ -118757,10 +119903,10 @@ x-webhooks: type: string enum: - created - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories: &700 + organization: *691 + repositories: &710 description: An array of repository objects that the installation can access. type: array @@ -118786,8 +119932,8 @@ x-webhooks: - name - full_name - private - repository: *682 - requester: *699 + repository: *692 + requester: *709 sender: *4 required: - action @@ -118862,11 +120008,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories: *700 - repository: *682 + organization: *691 + repositories: *710 + repository: *692 requester: nullable: true sender: *4 @@ -118942,11 +120088,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories: *700 - repository: *682 + organization: *691 + repositories: *710 + repository: *692 requester: nullable: true sender: *4 @@ -119022,10 +120168,10 @@ x-webhooks: type: string enum: - added - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories_added: &701 + organization: *691 + repositories_added: &711 description: An array of repository objects, which were added to the installation. type: array @@ -119071,15 +120217,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *682 - repository_selection: &702 + repository: *692 + repository_selection: &712 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *699 + requester: *709 sender: *4 required: - action @@ -119158,10 +120304,10 @@ x-webhooks: type: string enum: - removed - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories_added: *701 + organization: *691 + repositories_added: *711 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -119188,9 +120334,9 @@ x-webhooks: - name - full_name - private - repository: *682 - repository_selection: *702 - requester: *699 + repository: *692 + repository_selection: *712 + requester: *709 sender: *4 required: - action @@ -119269,11 +120415,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories: *700 - repository: *682 + organization: *691 + repositories: *710 + repository: *692 requester: nullable: true sender: *4 @@ -119451,10 +120597,10 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 target_type: type: string @@ -119533,11 +120679,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *679 + enterprise: *689 installation: *22 - organization: *681 - repositories: *700 - repository: *682 + organization: *691 + repositories: *710 + repository: *692 requester: nullable: true sender: *4 @@ -119789,8 +120935,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -120584,7 +121730,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -120600,7 +121747,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -120933,8 +122080,8 @@ x-webhooks: - state - locked - assignee - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -121014,7 +122161,7 @@ x-webhooks: type: string enum: - deleted - comment: &703 + comment: &713 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -121179,8 +122326,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -121970,7 +123117,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -121986,7 +123134,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -122321,8 +123469,8 @@ x-webhooks: - state - locked - assignee - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -122402,7 +123550,7 @@ x-webhooks: type: string enum: - edited - changes: &731 + changes: &743 description: The changes to the comment. type: object properties: @@ -122414,9 +123562,9 @@ x-webhooks: type: string required: - from - comment: *703 - enterprise: *679 - installation: *680 + comment: *713 + enterprise: *689 + installation: *690 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -123209,7 +124357,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -123225,7 +124374,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -123558,8 +124707,8 @@ x-webhooks: - state - locked - assignee - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -123649,9 +124798,9 @@ x-webhooks: type: number blocking_issue: *77 blocking_issue_repo: *60 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -123745,9 +124894,9 @@ x-webhooks: type: number blocking_issue: *77 blocking_issue_repo: *60 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -123840,9 +124989,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -123936,9 +125085,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -124023,10 +125172,10 @@ x-webhooks: type: string enum: - assigned - assignee: *699 - enterprise: *679 - installation: *680 - issue: &706 + assignee: *709 + enterprise: *689 + installation: *690 + issue: &716 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -124815,7 +125964,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -124831,7 +125981,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -124932,8 +126082,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -125013,8 +126163,8 @@ x-webhooks: type: string enum: - closed - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -125808,7 +126958,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -125824,7 +126975,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -126060,8 +127211,8 @@ x-webhooks: required: - state - closed_at - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -126140,8 +127291,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126926,7 +128077,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -126942,7 +128094,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -127042,8 +128194,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -127122,8 +128274,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127930,7 +129082,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127946,7 +129099,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -128025,7 +129178,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &704 + milestone: &714 title: Milestone description: A collection of related issues and pull requests. type: object @@ -128163,8 +129316,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -128263,8 +129416,8 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129053,7 +130206,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129066,7 +130220,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *196 + type: *199 title: description: Title of the issue type: string @@ -129170,9 +130324,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *698 - organization: *681 - repository: *682 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -129252,8 +130406,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -130041,7 +131195,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130054,7 +131209,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *196 + type: *199 title: description: Title of the issue type: string @@ -130158,9 +131313,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *698 - organization: *681 - repository: *682 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -130240,8 +131395,8 @@ x-webhooks: type: string enum: - locked - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131053,7 +132208,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131066,7 +132222,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *196 + type: *199 title: description: Title of the issue type: string @@ -131147,8 +132303,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -131227,8 +132383,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132034,7 +133190,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132050,7 +133207,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -132128,9 +133285,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *704 - organization: *681 - repository: *682 + milestone: *714 + organization: *691 + repository: *692 sender: *4 required: - action @@ -132998,7 +134155,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133091,7 +134249,7 @@ x-webhooks: required: - login - id - type: *196 + type: *199 required: - id - number @@ -133560,8 +134718,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134350,7 +135508,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134366,7 +135525,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -134466,8 +135625,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -134547,9 +135706,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *679 - installation: *680 - issue: &705 + enterprise: *689 + installation: *690 + issue: &715 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -135332,7 +136491,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135348,7 +136508,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -135448,8 +136608,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -135528,8 +136688,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136339,7 +137499,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136433,9 +137594,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *196 - organization: *681 - repository: *682 + type: *199 + organization: *691 + repository: *692 sender: *4 required: - action @@ -137301,7 +138462,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137317,7 +138479,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -137885,11 +139047,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *679 - installation: *680 - issue: *705 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *715 + organization: *691 + repository: *692 sender: *4 required: - action @@ -137969,12 +139131,12 @@ x-webhooks: type: string enum: - typed - enterprise: *679 - installation: *680 - issue: *706 - type: *196 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *716 + type: *199 + organization: *691 + repository: *692 sender: *4 required: - action @@ -138055,7 +139217,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &734 + assignee: &746 title: User type: object nullable: true @@ -138125,11 +139287,11 @@ x-webhooks: required: - login - id - enterprise: *679 - installation: *680 - issue: *706 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *716 + organization: *691 + repository: *692 sender: *4 required: - action @@ -138208,12 +139370,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *679 - installation: *680 - issue: *706 - label: *698 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *716 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -138293,8 +139455,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139104,7 +140266,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *616 + sub_issues_summary: *626 + issue_dependencies_summary: *627 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139120,7 +140283,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *196 + type: *199 updated_at: type: string format: date-time @@ -139198,8 +140361,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139279,11 +140442,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *679 - installation: *680 - issue: *705 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *715 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139362,12 +140525,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *679 - installation: *680 - issue: *706 - type: *196 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + issue: *716 + type: *199 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139447,11 +140610,11 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - label: *698 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139529,11 +140692,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - label: *698 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139643,11 +140806,11 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - label: *698 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + label: *708 + organization: *691 + repository: *692 sender: *4 required: - action @@ -139729,9 +140892,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *679 - installation: *680 - marketplace_purchase: &707 + enterprise: *689 + installation: *690 + marketplace_purchase: &717 title: Marketplace Purchase type: object required: @@ -139814,8 +140977,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *681 - previous_marketplace_purchase: &708 + organization: *691 + previous_marketplace_purchase: &718 title: Marketplace Purchase type: object properties: @@ -139895,7 +141058,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *682 + repository: *692 sender: *4 required: - action @@ -139975,10 +141138,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *679 - installation: *680 - marketplace_purchase: *707 - organization: *681 + enterprise: *689 + installation: *690 + marketplace_purchase: *717 + organization: *691 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -140061,7 +141224,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *682 + repository: *692 sender: *4 required: - action @@ -140143,10 +141306,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *679 - installation: *680 - marketplace_purchase: *707 - organization: *681 + enterprise: *689 + installation: *690 + marketplace_purchase: *717 + organization: *691 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -140228,7 +141391,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *682 + repository: *692 sender: *4 required: - action @@ -140309,8 +141472,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 marketplace_purchase: title: Marketplace Purchase type: object @@ -140392,9 +141555,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *681 - previous_marketplace_purchase: *708 - repository: *682 + organization: *691 + previous_marketplace_purchase: *718 + repository: *692 sender: *4 required: - action @@ -140474,12 +141637,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *679 - installation: *680 - marketplace_purchase: *707 - organization: *681 - previous_marketplace_purchase: *708 - repository: *682 + enterprise: *689 + installation: *690 + marketplace_purchase: *717 + organization: *691 + previous_marketplace_purchase: *718 + repository: *692 sender: *4 required: - action @@ -140581,11 +141744,11 @@ x-webhooks: type: string required: - to - enterprise: *679 - installation: *680 - member: *699 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + member: *709 + organization: *691 + repository: *692 sender: *4 required: - action @@ -140685,11 +141848,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *679 - installation: *680 - member: *699 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + member: *709 + organization: *691 + repository: *692 sender: *4 required: - action @@ -140768,11 +141931,11 @@ x-webhooks: type: string enum: - removed - enterprise: *679 - installation: *680 - member: *699 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + member: *709 + organization: *691 + repository: *692 sender: *4 required: - action @@ -140850,11 +142013,11 @@ x-webhooks: type: string enum: - added - enterprise: *679 - installation: *680 - member: *699 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + member: *709 + organization: *691 + repository: *692 scope: description: The scope of the membership. Currently, can only be `team`. @@ -140930,7 +142093,7 @@ x-webhooks: required: - login - id - team: &709 + team: &719 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -141120,11 +142283,11 @@ x-webhooks: type: string enum: - removed - enterprise: *679 - installation: *680 - member: *699 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + member: *709 + organization: *691 + repository: *692 scope: description: The scope of the membership. Currently, can only be `team`. @@ -141201,7 +142364,7 @@ x-webhooks: required: - login - id - team: *709 + team: *719 required: - action - scope @@ -141283,8 +142446,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *680 - merge_group: &711 + installation: *690 + merge_group: &721 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -141303,15 +142466,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *710 + head_commit: *720 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -141397,10 +142560,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *680 - merge_group: *711 - organization: *681 - repository: *682 + installation: *690 + merge_group: *721 + organization: *691 + repository: *692 sender: *4 required: - action @@ -141473,7 +142636,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 + enterprise: *689 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -141582,16 +142745,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *680 - organization: *681 + installation: *690 + organization: *691 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *712 - required: *713 + properties: *722 + required: *723 nullable: true sender: *4 required: @@ -141672,11 +142835,11 @@ x-webhooks: type: string enum: - closed - enterprise: *679 - installation: *680 - milestone: *704 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + milestone: *714 + organization: *691 + repository: *692 sender: *4 required: - action @@ -141755,9 +142918,9 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - milestone: &714 + enterprise: *689 + installation: *690 + milestone: &724 title: Milestone description: A collection of related issues and pull requests. type: object @@ -141894,8 +143057,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -141974,11 +143137,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - milestone: *704 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + milestone: *714 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142088,11 +143251,11 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - milestone: *704 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + milestone: *714 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142172,11 +143335,11 @@ x-webhooks: type: string enum: - opened - enterprise: *679 - installation: *680 - milestone: *714 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + milestone: *724 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142255,11 +143418,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *699 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + blocked_user: *709 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142338,11 +143501,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *699 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + blocked_user: *709 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142421,9 +143584,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - membership: &715 + enterprise: *689 + installation: *690 + membership: &725 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -142530,8 +143693,8 @@ x-webhooks: - role - organization_url - user - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142609,11 +143772,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *679 - installation: *680 - membership: *715 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + membership: *725 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142692,8 +143855,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -142809,10 +143972,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 - user: *699 + user: *709 required: - action - invitation @@ -142890,11 +144053,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *679 - installation: *680 - membership: *715 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + membership: *725 + organization: *691 + repository: *692 sender: *4 required: - action @@ -142981,11 +144144,11 @@ x-webhooks: properties: from: type: string - enterprise: *679 - installation: *680 - membership: *715 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + membership: *725 + organization: *691 + repository: *692 sender: *4 required: - action @@ -143061,9 +144224,9 @@ x-webhooks: type: string enum: - published - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 package: description: Information about the package. type: object @@ -143562,7 +144725,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &716 + items: &726 title: Ruby Gems metadata type: object properties: @@ -143657,7 +144820,7 @@ x-webhooks: - owner - package_version - registry - repository: *682 + repository: *692 sender: *4 required: - action @@ -143733,9 +144896,9 @@ x-webhooks: type: string enum: - updated - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 package: description: Information about the package. type: object @@ -144088,7 +145251,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *716 + items: *726 source_url: type: string format: uri @@ -144158,7 +145321,7 @@ x-webhooks: - owner - package_version - registry - repository: *682 + repository: *692 sender: *4 required: - action @@ -144335,12 +145498,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *679 + enterprise: *689 id: type: integer - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - id @@ -144417,7 +145580,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &717 + personal_access_token_request: &727 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -144563,10 +145726,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *679 - organization: *681 + enterprise: *689 + organization: *691 sender: *4 - installation: *680 + installation: *690 required: - action - personal_access_token_request @@ -144643,11 +145806,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *717 - enterprise: *679 - organization: *681 + personal_access_token_request: *727 + enterprise: *689 + organization: *691 sender: *4 - installation: *680 + installation: *690 required: - action - personal_access_token_request @@ -144723,11 +145886,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *717 - enterprise: *679 - organization: *681 + personal_access_token_request: *727 + enterprise: *689 + organization: *691 sender: *4 - installation: *680 + installation: *690 required: - action - personal_access_token_request @@ -144802,11 +145965,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *717 - organization: *681 - enterprise: *679 + personal_access_token_request: *727 + organization: *691 + enterprise: *689 sender: *4 - installation: *680 + installation: *690 required: - action - personal_access_token_request @@ -144911,7 +146074,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *718 + last_response: *728 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -144943,8 +146106,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 zen: description: Random string of GitHub zen. @@ -145189,10 +146352,10 @@ x-webhooks: - from required: - note - enterprise: *679 - installation: *680 - organization: *681 - project_card: &719 + enterprise: *689 + installation: *690 + organization: *691 + project_card: &729 title: Project Card type: object properties: @@ -145311,7 +146474,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *682 + repository: *692 sender: *4 required: - action @@ -145392,11 +146555,11 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - project_card: *719 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project_card: *729 + repository: *692 sender: *4 required: - action @@ -145476,9 +146639,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 project_card: title: Project Card type: object @@ -145606,8 +146769,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *712 - required: *713 + properties: *722 + required: *723 nullable: true sender: *4 required: @@ -145701,11 +146864,11 @@ x-webhooks: - from required: - note - enterprise: *679 - installation: *680 - organization: *681 - project_card: *719 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project_card: *729 + repository: *692 sender: *4 required: - action @@ -145799,9 +146962,9 @@ x-webhooks: - from required: - column_id - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 project_card: allOf: - title: Project Card @@ -145991,7 +147154,7 @@ x-webhooks: type: string required: - after_id - repository: *682 + repository: *692 sender: *4 required: - action @@ -146071,10 +147234,10 @@ x-webhooks: type: string enum: - closed - enterprise: *679 - installation: *680 - organization: *681 - project: &721 + enterprise: *689 + installation: *690 + organization: *691 + project: &731 title: Project type: object properties: @@ -146198,7 +147361,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *682 + repository: *692 sender: *4 required: - action @@ -146278,10 +147441,10 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - project_column: &720 + enterprise: *689 + installation: *690 + organization: *691 + project_column: &730 title: Project Column type: object properties: @@ -146320,7 +147483,7 @@ x-webhooks: - name - created_at - updated_at - repository: *682 + repository: *692 sender: *4 required: - action @@ -146399,18 +147562,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - project_column: *720 + enterprise: *689 + installation: *690 + organization: *691 + project_column: *730 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *712 - required: *713 + properties: *722 + required: *723 nullable: true sender: *4 required: @@ -146500,11 +147663,11 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - organization: *681 - project_column: *720 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project_column: *730 + repository: *692 sender: *4 required: - action @@ -146584,11 +147747,11 @@ x-webhooks: type: string enum: - moved - enterprise: *679 - installation: *680 - organization: *681 - project_column: *720 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project_column: *730 + repository: *692 sender: *4 required: - action @@ -146668,11 +147831,11 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - project: *721 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project: *731 + repository: *692 sender: *4 required: - action @@ -146752,18 +147915,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - project: *721 + enterprise: *689 + installation: *690 + organization: *691 + project: *731 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *712 - required: *713 + properties: *722 + required: *723 nullable: true sender: *4 required: @@ -146865,11 +148028,11 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - organization: *681 - project: *721 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project: *731 + repository: *692 sender: *4 required: - action @@ -146948,11 +148111,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *679 - installation: *680 - organization: *681 - project: *721 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + project: *731 + repository: *692 sender: *4 required: - action @@ -147033,9 +148196,9 @@ x-webhooks: type: string enum: - closed - installation: *680 - organization: *681 - projects_v2: &722 + installation: *690 + organization: *691 + projects_v2: &732 title: Projects v2 Project description: A projects v2 project type: object @@ -147083,6 +148246,62 @@ x-webhooks: properties: *20 required: *21 nullable: true + state: + type: string + enum: + - open + - closed + latest_status_update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: &737 + id: + type: number + node_id: + type: string + project_node_id: + type: string + creator: *4 + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + start_date: + type: string + format: date + example: '2022-04-28' + target_date: + type: string + format: date + example: '2022-04-28' + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: &738 + - id + - node_id + - created_at + - updated_at + nullable: true + is_template: + type: boolean + description: Whether this project is a template required: - id - node_id @@ -147178,9 +148397,9 @@ x-webhooks: type: string enum: - created - installation: *680 - organization: *681 - projects_v2: *722 + installation: *690 + organization: *691 + projects_v2: *732 sender: *4 required: - action @@ -147261,9 +148480,9 @@ x-webhooks: type: string enum: - deleted - installation: *680 - organization: *681 - projects_v2: *722 + installation: *690 + organization: *691 + projects_v2: *732 sender: *4 required: - action @@ -147380,9 +148599,9 @@ x-webhooks: type: string to: type: string - installation: *680 - organization: *681 - projects_v2: *722 + installation: *690 + organization: *691 + projects_v2: *732 sender: *4 required: - action @@ -147465,7 +148684,7 @@ x-webhooks: type: string enum: - archived - changes: &726 + changes: &736 type: object properties: archived_at: @@ -147479,9 +148698,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *680 - organization: *681 - projects_v2_item: &723 + installation: *690 + organization: *691 + projects_v2_item: &733 title: Projects v2 Item description: An item belonging to a project type: object @@ -147615,9 +148834,9 @@ x-webhooks: nullable: true to: type: string - installation: *680 - organization: *681 - projects_v2_item: *723 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -147699,9 +148918,9 @@ x-webhooks: type: string enum: - created - installation: *680 - organization: *681 - projects_v2_item: *723 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -147782,9 +149001,9 @@ x-webhooks: type: string enum: - deleted - installation: *680 - organization: *681 - projects_v2_item: *723 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -147890,7 +149109,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &724 + - &734 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -147908,7 +149127,7 @@ x-webhooks: required: - id - name - - &725 + - &735 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -147931,8 +149150,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *724 - - *725 + - *734 + - *735 required: - field_value - type: object @@ -147948,9 +149167,9 @@ x-webhooks: nullable: true required: - body - installation: *680 - organization: *681 - projects_v2_item: *723 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -148045,9 +149264,9 @@ x-webhooks: to: type: string nullable: true - installation: *680 - organization: *681 - projects_v2_item: *723 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -148130,10 +149349,10 @@ x-webhooks: type: string enum: - restored - changes: *726 - installation: *680 - organization: *681 - projects_v2_item: *723 + changes: *736 + installation: *690 + organization: *691 + projects_v2_item: *733 sender: *4 required: - action @@ -148215,9 +149434,9 @@ x-webhooks: type: string enum: - reopened - installation: *680 - organization: *681 - projects_v2: *722 + installation: *690 + organization: *691 + projects_v2: *732 sender: *4 required: - action @@ -148298,55 +149517,14 @@ x-webhooks: type: string enum: - created - installation: *680 - organization: *681 - projects_v2_status_update: &727 + installation: *690 + organization: *691 + projects_v2_status_update: &739 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: - id: - type: number - node_id: - type: string - project_node_id: - type: string - creator: *4 - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - status: - type: string - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - nullable: true - start_date: - type: string - format: date - example: '2022-04-28' - target_date: - type: string - format: date - example: '2022-04-28' - body: - description: Body of the status update - example: The project is off to a great start! - type: string - nullable: true - required: - - id - - node_id - - created_at - - updated_at + properties: *737 + required: *738 sender: *4 required: - action @@ -148427,9 +149605,9 @@ x-webhooks: type: string enum: - deleted - installation: *680 - organization: *681 - projects_v2_status_update: *727 + installation: *690 + organization: *691 + projects_v2_status_update: *739 sender: *4 required: - action @@ -148565,9 +149743,9 @@ x-webhooks: type: string format: date nullable: true - installation: *680 - organization: *681 - projects_v2_status_update: *727 + installation: *690 + organization: *691 + projects_v2_status_update: *739 sender: *4 required: - action @@ -148638,10 +149816,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - repository @@ -148718,13 +149896,13 @@ x-webhooks: type: string enum: - assigned - assignee: *699 - enterprise: *679 - installation: *680 - number: &728 + assignee: *709 + enterprise: *689 + installation: *690 + number: &740 description: The pull request number. type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -151007,7 +152185,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -151089,11 +152267,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -153371,7 +154549,7 @@ x-webhooks: - draft reason: type: string - repository: *682 + repository: *692 sender: *4 required: - action @@ -153453,11 +154631,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -155735,7 +156913,7 @@ x-webhooks: - draft reason: type: string - repository: *682 + repository: *692 sender: *4 required: - action @@ -155817,13 +156995,13 @@ x-webhooks: type: string enum: - closed - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: &729 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: &741 allOf: - - *547 + - *557 - type: object properties: allow_auto_merge: @@ -155885,7 +157063,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *682 + repository: *692 sender: *4 required: - action @@ -155966,12 +157144,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: *729 - repository: *682 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: *741 + repository: *692 sender: *4 required: - action @@ -156051,11 +157229,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *679 - milestone: *530 - number: *728 - organization: *681 - pull_request: &730 + enterprise: *689 + milestone: *540 + number: *740 + organization: *691 + pull_request: &742 title: Pull Request type: object properties: @@ -158318,7 +159496,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -158397,11 +159575,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -160683,7 +161861,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *682 + repository: *692 sender: *4 required: - action @@ -160807,12 +161985,12 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: *729 - repository: *682 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: *741 + repository: *692 sender: *4 required: - action @@ -160892,11 +162070,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -163163,7 +164341,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -163243,11 +164421,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *679 - installation: *680 - label: *698 - number: *728 - organization: *681 + enterprise: *689 + installation: *690 + label: *708 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -165529,7 +166707,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -165610,10 +166788,10 @@ x-webhooks: type: string enum: - locked - enterprise: *679 - installation: *680 - number: *728 - organization: *681 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -167893,7 +169071,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -167973,12 +169151,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *679 - milestone: *530 - number: *728 - organization: *681 - pull_request: *730 - repository: *682 + enterprise: *689 + milestone: *540 + number: *740 + organization: *691 + pull_request: *742 + repository: *692 sender: *4 required: - action @@ -168057,12 +169235,12 @@ x-webhooks: type: string enum: - opened - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: *729 - repository: *682 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: *741 + repository: *692 sender: *4 required: - action @@ -168143,12 +169321,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: *729 - repository: *682 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: *741 + repository: *692 sender: *4 required: - action @@ -168228,12 +169406,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *679 - installation: *680 - number: *728 - organization: *681 - pull_request: *729 - repository: *682 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 + pull_request: *741 + repository: *692 sender: *4 required: - action @@ -168599,9 +169777,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: type: object properties: @@ -170771,7 +171949,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *682 + repository: *692 sender: *4 required: - action @@ -170851,7 +172029,7 @@ x-webhooks: type: string enum: - deleted - comment: &732 + comment: &744 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -171136,9 +172314,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: type: object properties: @@ -173296,7 +174474,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *682 + repository: *692 sender: *4 required: - action @@ -173376,11 +174554,11 @@ x-webhooks: type: string enum: - edited - changes: *731 - comment: *732 - enterprise: *679 - installation: *680 - organization: *681 + changes: *743 + comment: *744 + enterprise: *689 + installation: *690 + organization: *691 pull_request: type: object properties: @@ -175541,7 +176719,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *682 + repository: *692 sender: *4 required: - action @@ -175622,9 +176800,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: title: Simple Pull Request type: object @@ -177797,7 +178975,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *682 + repository: *692 review: description: The review that was affected. type: object @@ -178040,9 +179218,9 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: title: Simple Pull Request type: object @@ -180096,8 +181274,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *682 - review: &733 + repository: *692 + review: &745 description: The review that was affected. type: object properties: @@ -180326,12 +181504,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: description: The pull request number. type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -182614,7 +183792,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 requested_reviewer: title: User type: object @@ -182698,12 +183876,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: description: The pull request number. type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -184993,7 +186171,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 requested_team: title: Team description: Groups of organization members that gives permissions @@ -185185,12 +186363,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: description: The pull request number. type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -187475,7 +188653,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 requested_reviewer: title: User type: object @@ -187560,12 +188738,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *679 - installation: *680 + enterprise: *689 + installation: *690 number: description: The pull request number. type: integer - organization: *681 + organization: *691 pull_request: title: Pull Request type: object @@ -189841,7 +191019,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190022,9 +191200,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: title: Simple Pull Request type: object @@ -192199,8 +193377,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *682 - review: *733 + repository: *692 + review: *745 sender: *4 required: - action @@ -192280,9 +193458,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: title: Simple Pull Request type: object @@ -194352,7 +195530,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *682 + repository: *692 sender: *4 thread: type: object @@ -194735,9 +195913,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 pull_request: title: Simple Pull Request type: object @@ -196793,7 +197971,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *682 + repository: *692 sender: *4 thread: type: object @@ -197179,10 +198357,10 @@ x-webhooks: type: string before: type: string - enterprise: *679 - installation: *680 - number: *728 - organization: *681 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -199453,7 +200631,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -199535,11 +200713,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *734 - enterprise: *679 - installation: *680 - number: *728 - organization: *681 + assignee: *746 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -201822,7 +203000,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -201901,11 +203079,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *679 - installation: *680 - label: *698 - number: *728 - organization: *681 + enterprise: *689 + installation: *690 + label: *708 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -204178,7 +205356,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -204259,10 +205437,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *679 - installation: *680 - number: *728 - organization: *681 + enterprise: *689 + installation: *690 + number: *740 + organization: *691 pull_request: title: Pull Request type: object @@ -206527,7 +207705,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *682 + repository: *692 sender: *4 required: - action @@ -206727,7 +207905,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *679 + enterprise: *689 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -206819,8 +207997,8 @@ x-webhooks: - url - author - committer - installation: *680 - organization: *681 + installation: *690 + organization: *691 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -207395,9 +208573,9 @@ x-webhooks: type: string enum: - published - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 registry_package: type: object properties: @@ -207843,7 +209021,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *716 + items: *726 summary: type: string tag_name: @@ -207897,7 +209075,7 @@ x-webhooks: - owner - package_version - registry - repository: *682 + repository: *692 sender: *4 required: - action @@ -207975,9 +209153,9 @@ x-webhooks: type: string enum: - updated - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 registry_package: type: object properties: @@ -208285,7 +209463,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *716 + items: *726 summary: type: string tag_name: @@ -208334,7 +209512,7 @@ x-webhooks: - owner - package_version - registry - repository: *682 + repository: *692 sender: *4 required: - action @@ -208411,10 +209589,10 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - release: &735 + enterprise: *689 + installation: *690 + organization: *691 + release: &747 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -208727,7 +209905,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *682 + repository: *692 sender: *4 required: - action @@ -208804,11 +209982,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - release: *735 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + release: *747 + repository: *692 sender: *4 required: - action @@ -208925,11 +210103,11 @@ x-webhooks: type: boolean required: - to - enterprise: *679 - installation: *680 - organization: *681 - release: *735 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + release: *747 + repository: *692 sender: *4 required: - action @@ -209007,9 +210185,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -209326,7 +210504,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *682 + repository: *692 sender: *4 required: - action @@ -209402,10 +210580,10 @@ x-webhooks: type: string enum: - published - enterprise: *679 - installation: *680 - organization: *681 - release: &736 + enterprise: *689 + installation: *690 + organization: *691 + release: &748 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -209719,7 +210897,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *682 + repository: *692 sender: *4 required: - action @@ -209795,11 +210973,11 @@ x-webhooks: type: string enum: - released - enterprise: *679 - installation: *680 - organization: *681 - release: *735 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + release: *747 + repository: *692 sender: *4 required: - action @@ -209875,11 +211053,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *679 - installation: *680 - organization: *681 - release: *736 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + release: *748 + repository: *692 sender: *4 required: - action @@ -209955,11 +211133,11 @@ x-webhooks: type: string enum: - published - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - repository_advisory: *602 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + repository_advisory: *612 sender: *4 required: - action @@ -210035,11 +211213,11 @@ x-webhooks: type: string enum: - reported - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - repository_advisory: *602 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + repository_advisory: *612 sender: *4 required: - action @@ -210115,10 +211293,10 @@ x-webhooks: type: string enum: - archived - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210195,10 +211373,10 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210276,10 +211454,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210363,10 +211541,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210478,10 +211656,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210553,10 +211731,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 status: type: string @@ -210637,10 +211815,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210717,10 +211895,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210814,10 +211992,10 @@ x-webhooks: - name required: - repository - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -210897,11 +212075,11 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - repository_ruleset: *267 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + repository_ruleset: *270 sender: *4 required: - action @@ -210979,11 +212157,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - repository_ruleset: *267 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + repository_ruleset: *270 sender: *4 required: - action @@ -211061,11 +212239,11 @@ x-webhooks: type: string enum: - edited - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - repository_ruleset: *267 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + repository_ruleset: *270 changes: type: object properties: @@ -211084,16 +212262,16 @@ x-webhooks: properties: added: type: array - items: *242 + items: *245 deleted: type: array - items: *242 + items: *245 updated: type: array items: type: object properties: - condition: *242 + condition: *245 changes: type: object properties: @@ -211126,16 +212304,16 @@ x-webhooks: properties: added: type: array - items: *567 + items: *577 deleted: type: array - items: *567 + items: *577 updated: type: array items: type: object properties: - rule: *567 + rule: *577 changes: type: object properties: @@ -211369,10 +212547,10 @@ x-webhooks: - from required: - owner - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -211450,10 +212628,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -211531,7 +212709,7 @@ x-webhooks: type: string enum: - create - alert: &737 + alert: &749 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -211652,10 +212830,10 @@ x-webhooks: type: string enum: - open - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -211861,10 +213039,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -211942,11 +213120,11 @@ x-webhooks: type: string enum: - reopen - alert: *737 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + alert: *749 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212145,10 +213323,10 @@ x-webhooks: enum: - fixed - open - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212226,7 +213404,7 @@ x-webhooks: type: string enum: - created - alert: &738 + alert: &750 type: object properties: number: *54 @@ -212337,10 +213515,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212421,11 +213599,11 @@ x-webhooks: type: string enum: - created - alert: *738 - installation: *680 - location: *739 - organization: *681 - repository: *682 + alert: *750 + installation: *690 + location: *751 + organization: *691 + repository: *692 sender: *4 required: - location @@ -212663,11 +213841,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *738 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + alert: *750 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212745,11 +213923,11 @@ x-webhooks: type: string enum: - reopened - alert: *738 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + alert: *750 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212827,11 +214005,11 @@ x-webhooks: type: string enum: - resolved - alert: *738 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + alert: *750 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -212909,11 +214087,11 @@ x-webhooks: type: string enum: - validated - alert: *738 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + alert: *750 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -213039,10 +214217,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *682 - enterprise: *679 - installation: *680 - organization: *681 + repository: *692 + enterprise: *689 + installation: *690 + organization: *691 sender: *4 required: - action @@ -213120,11 +214298,11 @@ x-webhooks: type: string enum: - published - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - security_advisory: &740 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + security_advisory: &752 description: The details of the security advisory, including summary, description, and severity. type: object @@ -213307,11 +214485,11 @@ x-webhooks: type: string enum: - updated - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 - security_advisory: *740 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 + security_advisory: *752 sender: *4 required: - action @@ -213384,10 +214562,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -213571,11 +214749,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *241 - enterprise: *679 - installation: *680 - organization: *681 - repository: *315 + security_and_analysis: *244 + enterprise: *689 + installation: *690 + organization: *691 + repository: *320 sender: *4 required: - changes @@ -213653,12 +214831,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: &741 + sponsorship: &753 type: object properties: created_at: @@ -213959,12 +215137,12 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: *741 + sponsorship: *753 required: - action - sponsorship @@ -214052,12 +215230,12 @@ x-webhooks: type: string required: - from - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: *741 + sponsorship: *753 required: - action - changes @@ -214134,17 +215312,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &742 + effective_date: &754 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: *741 + sponsorship: *753 required: - action - sponsorship @@ -214218,7 +215396,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &743 + changes: &755 type: object properties: tier: @@ -214262,13 +215440,13 @@ x-webhooks: - from required: - tier - effective_date: *742 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + effective_date: *754 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: *741 + sponsorship: *753 required: - action - changes @@ -214345,13 +215523,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *743 - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + changes: *755 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - sponsorship: *741 + sponsorship: *753 required: - action - changes @@ -214425,10 +215603,10 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -214511,10 +215689,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -214934,15 +216112,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *679 + enterprise: *689 id: description: The unique identifier of the status. type: integer - installation: *680 + installation: *690 name: type: string - organization: *681 - repository: *682 + organization: *691 + repository: *692 sender: *4 sha: description: The Commit SHA. @@ -215057,9 +216235,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -215149,9 +216327,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -215241,9 +216419,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -215333,9 +216511,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *77 - installation: *680 - organization: *681 - repository: *682 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -215412,12 +216590,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - team: &744 + team: &756 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -215607,9 +216785,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 repository: title: Repository description: A git repository @@ -216067,7 +217245,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *744 + team: *756 required: - action - team @@ -216143,9 +217321,9 @@ x-webhooks: type: string enum: - created - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 repository: title: Repository description: A git repository @@ -216603,7 +217781,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *744 + team: *756 required: - action - team @@ -216680,9 +217858,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 repository: title: Repository description: A git repository @@ -217140,7 +218318,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *744 + team: *756 required: - action - team @@ -217284,9 +218462,9 @@ x-webhooks: - from required: - permissions - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 repository: title: Repository description: A git repository @@ -217744,7 +218922,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *744 + team: *756 required: - action - changes @@ -217822,9 +219000,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *679 - installation: *680 - organization: *681 + enterprise: *689 + installation: *690 + organization: *691 repository: title: Repository description: A git repository @@ -218282,7 +219460,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *744 + team: *756 required: - action - team @@ -218358,10 +219536,10 @@ x-webhooks: type: string enum: - started - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 required: - action @@ -218434,16 +219612,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *679 + enterprise: *689 inputs: type: object nullable: true additionalProperties: true - installation: *680 - organization: *681 + installation: *690 + organization: *691 ref: type: string - repository: *682 + repository: *692 sender: *4 workflow: type: string @@ -218525,10 +219703,10 @@ x-webhooks: type: string enum: - completed - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 workflow_job: allOf: @@ -218765,7 +219943,7 @@ x-webhooks: type: string required: - conclusion - deployment: *462 + deployment: *472 required: - action - repository @@ -218844,10 +220022,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 workflow_job: allOf: @@ -219107,7 +220285,7 @@ x-webhooks: required: - status - steps - deployment: *462 + deployment: *472 required: - action - repository @@ -219186,10 +220364,10 @@ x-webhooks: type: string enum: - queued - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 workflow_job: type: object @@ -219324,7 +220502,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *462 + deployment: *472 required: - action - repository @@ -219403,10 +220581,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 workflow_job: type: object @@ -219542,7 +220720,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *462 + deployment: *472 required: - action - repository @@ -219622,12 +220800,12 @@ x-webhooks: type: string enum: - completed - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - workflow: *694 + workflow: *704 workflow_run: title: Workflow Run type: object @@ -220626,12 +221804,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - workflow: *694 + workflow: *704 workflow_run: title: Workflow Run type: object @@ -221615,12 +222793,12 @@ x-webhooks: type: string enum: - requested - enterprise: *679 - installation: *680 - organization: *681 - repository: *682 + enterprise: *689 + installation: *690 + organization: *691 + repository: *692 sender: *4 - workflow: *694 + workflow: *704 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index bd832a92ab..ef7b78401f 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -203,6 +203,10 @@ { "name": "credentials", "description": "Revoke compromised or leaked GitHub credentials." + }, + { + "name": "projects", + "description": "Endpoints to manage Projects using the REST API." } ], "servers": [ @@ -18861,6 +18865,781 @@ } } }, + "/enterprises/{enterprise}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an enterprise", + "description": "Gets artifact and log retention settings for an enterprise.", + "operationId": "enterprise-admin/get-artifact-and-log-retention-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the artifact and log retention settings", + "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": { + "summary": "Example response", + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "401": { + "description": "Authorization failure" + }, + "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": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for an enterprise", + "description": "Sets artifact and log retention settings for an enterprise.", + "operationId": "enterprise-admin/set-artifact-and-log-retention-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Successfully updated the artifact and log retention settings" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "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": { + "default": { + "summary": "Set retention to 100 days", + "value": { + "days": 100 + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for an enterprise", + "description": "Gets the fork PR contributor approval policy for an enterprise.", + "operationId": "enterprise-admin/get-fork-pr-contributor-approval-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an enterprise", + "description": "Sets the fork PR contributor approval policy for an enterprise.", + "operationId": "enterprise-admin/set-fork-pr-contributor-approval-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for an enterprise", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise.", + "operationId": "enterprise-admin/get-private-repo-fork-pr-workflows-settings", + "tags": [ + "enterprise-admin" + ], + "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-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "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 + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for an enterprise", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise.", + "operationId": "enterprise-admin/set-private-repo-fork-pr-workflows-settings", + "tags": [ + "enterprise-admin" + ], + "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-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/enterprises/{enterprise}/actions/permissions/organizations": { "get": { "summary": "List selected organizations enabled for GitHub Actions in an enterprise", @@ -19330,6 +20109,247 @@ } } }, + "/enterprises/{enterprise}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners permissions for an enterprise", + "description": "Gets the settings for whether organizations in the enterprise are allowed to manage self-hosted runners at the repository level.", + "operationId": "enterprise-admin/get-self-hosted-runners-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "disable_self_hosted_runners_for_all_orgs": { + "type": "boolean", + "description": "When true, repository-level runners will be disabled across all organizations in the enterprise" + } + }, + "required": [ + "disable_self_hosted_runners_for_all_orgs" + ] + }, + "examples": { + "default": { + "value": { + "disable_self_hosted_runners_for_all_orgs": 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": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set self-hosted runners permissions for an enterprise", + "description": "Sets the settings for whether organizations in the enterprise are allowed to manage self-hosted runners at the repository level.", + "operationId": "enterprise-admin/set-self-hosted-runners-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "disable_self_hosted_runners_for_all_orgs": { + "type": "boolean", + "description": "When true, repository-level runners will be disabled across all organizations in the enterprise" + } + }, + "required": [ + "disable_self_hosted_runners_for_all_orgs" + ] + }, + "examples": { + "default": { + "summary": "Disable repository-level runners across all organizations", + "value": { + "disable_self_hosted_runners_for_all_orgs": true + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/enterprises/{enterprise}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an enterprise", @@ -36676,7 +37696,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -51735,159 +52755,23 @@ } } }, - "/enterprises/{enterprise}/settings/billing/actions": { + "/enterprises/{enterprise}/secret-scanning/pattern-configurations": { "get": { - "summary": "Get GitHub Actions billing for an enterprise", - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nThe authenticated user must be an enterprise admin.\n\n> [!NOTE]\n> This endpoint is available to enterprise customers who are using the legacy billing platform.", - "operationId": "billing/get-github-actions-billing-ghe", + "summary": "List enterprise pattern configurations", + "description": "Lists the secret scanning pattern configurations for an enterprise.\n\nPersonal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ - "billing" + "secret-scanning" ], + "operationId": "secret-scanning/list-enterprise-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-actions-billing-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total_minutes_used": { - "type": "integer", - "description": "The sum of the free and paid GitHub Actions minutes used." - }, - "total_paid_minutes_used": { - "type": "integer", - "description": "The total paid GitHub Actions minutes used." - }, - "included_minutes": { - "type": "integer", - "description": "The amount of free GitHub Actions minutes available." - }, - "minutes_used_breakdown": { - "type": "object", - "properties": { - "UBUNTU": { - "type": "integer", - "description": "Total minutes used on Ubuntu runner machines." - }, - "MACOS": { - "type": "integer", - "description": "Total minutes used on macOS runner machines." - }, - "WINDOWS": { - "type": "integer", - "description": "Total minutes used on Windows runner machines." - }, - "ubuntu_4_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 4 core runner machines." - }, - "ubuntu_8_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 8 core runner machines." - }, - "ubuntu_16_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 16 core runner machines." - }, - "ubuntu_32_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 32 core runner machines." - }, - "ubuntu_64_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 64 core runner machines." - }, - "windows_4_core": { - "type": "integer", - "description": "Total minutes used on Windows 4 core runner machines." - }, - "windows_8_core": { - "type": "integer", - "description": "Total minutes used on Windows 8 core runner machines." - }, - "windows_16_core": { - "type": "integer", - "description": "Total minutes used on Windows 16 core runner machines." - }, - "windows_32_core": { - "type": "integer", - "description": "Total minutes used on Windows 32 core runner machines." - }, - "windows_64_core": { - "type": "integer", - "description": "Total minutes used on Windows 64 core runner machines." - }, - "macos_12_core": { - "type": "integer", - "description": "Total minutes used on macOS 12 core runner machines." - }, - "total": { - "type": "integer", - "description": "Total minutes used on all runner machines." - } - } - } - }, - "required": [ - "total_minutes_used", - "total_paid_minutes_used", - "included_minutes", - "minutes_used_breakdown" - ] - }, - "examples": { - "default": { - "value": { - "total_minutes_used": 305, - "total_paid_minutes_used": 0, - "included_minutes": 3000, - "minutes_used_breakdown": { - "UBUNTU": 205, - "MACOS": 10, - "WINDOWS": 90 - } - } - } - } - } - } - } + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations" }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "billing" - } - } - }, - "/enterprises/{enterprise}/settings/billing/advanced-security": { - "get": { - "summary": "Get GitHub Advanced Security active committers for an enterprise", - "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.", - "tags": [ - "billing" - ], - "operationId": "billing/get-github-advanced-security-billing-ghe", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" }, "parameters": [ { @@ -51898,244 +52782,167 @@ "schema": { "type": "string" } - }, - { - "name": "advanced_security_product", - "in": "query", - "description": "The security product to get GitHub Advanced Security active committers for.\n\nFor standalone Code Scanning or Secret Protection products, this parameter is required to specify which product you want committer information for. For other plans this parameter cannot be used.\n", - "required": false, - "schema": { - "type": "string", - "enum": [ - "code_security", - "secret_protection" - ] - } - }, - { - "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": "Success", + "description": "Response", "content": { "application/json": { "schema": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", "type": "object", "properties": { - "total_advanced_security_committers": { - "type": "integer", - "example": 25 - }, - "total_count": { - "type": "integer", - "example": 2 - }, - "maximum_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" - }, - "purchased_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences purchased" + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true }, - "repositories": { + "provider_pattern_overrides": { "type": "array", + "description": "Overrides for partner patterns.", "items": { "type": "object", "properties": { - "name": { + "token_type": { "type": "string", - "example": "octocat/Hello-World" + "description": "The ID of the pattern." }, - "advanced_security_committers": { + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { "type": "integer", - "example": 25 + "description": "The total number of alerts generated by this pattern." }, - "advanced_security_committers_breakdown": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user_login": { - "type": "string" - }, - "last_pushed_date": { - "type": "string", - "example": "2021-11-03" - }, - "last_pushed_email": { - "type": "string", - "example": "monalisa@github.com" - } - }, - "required": [ - "user_login", - "last_pushed_date", - "last_pushed_email" - ] - } + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] } - }, - "required": [ - "name", - "advanced_security_committers", - "advanced_security_committers_breakdown" - ] - } - } - }, - "required": [ - "repositories" - ] - }, - "examples": { - "default": { - "value": { - "total_advanced_security_committers": 2, - "total_count": 2, - "maximum_advanced_security_committers": 4, - "purchased_advanced_security_committers": 4, - "repositories": [ - { - "name": "octocat-org/Hello-World", - "advanced_security_committers": 2, - "advanced_security_committers_breakdown": [ - { - "user_login": "octocat", - "last_pushed_date": "2021-11-03", - "last_pushed_email": "octocat@github.com" - }, - { - "user_login": "octokitten", - "last_pushed_date": "2021-10-25", - "last_pushed_email": "octokitten@github.com" - } - ] - }, - { - "name": "octocat-org/server", - "advanced_security_committers": 1, - "advanced_security_committers_breakdown": [ - { - "user_login": "octokitten", - "last_pushed_date": "2021-10-26", - "last_pushed_email": "octokitten@github.com" - } - ] } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "billing" - } - } - }, - "/enterprises/{enterprise}/settings/billing/cost-centers": { - "get": { - "summary": "Get all cost centers for an enterprise", - "description": "Gets a list of all the cost centers for an enterprise.", - "tags": [ - "billing" - ], - "operationId": "billing/get-all-cost-centers", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response when getting cost centers", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "costCenters": { + } + }, + "custom_pattern_overrides": { "type": "array", + "description": "Overrides for custom patterns defined by the organization.", "items": { "type": "object", "properties": { - "id": { + "token_type": { "type": "string", - "description": "ID of the cost center." + "description": "The ID of the pattern." }, - "name": { + "custom_pattern_version": { "type": "string", - "description": "Name of the cost center." + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true }, - "state": { + "slug": { "type": "string", - "description": "State of the cost center.", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", "enum": [ - "active", - "deleted" + "disabled", + "enabled" ] }, - "resources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of the resource." - }, - "name": { - "type": "string", - "description": "Name of the resource." - } - }, - "required": [ - "type", - "name" - ] - } + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] } - }, - "required": [ - "id", - "name", - "resources" - ] + } } } } @@ -52143,21 +52950,35 @@ "examples": { "default": { "value": { - "costCenters": [ + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ { - "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002", - "name": "Cost Center Name", - "state": "active", - "resources": [ - { - "type": "User", - "name": "Monalisa" - }, - { - "type": "Repo", - "name": "octocat/hello-world" - } - ] + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" } ] } @@ -52166,8 +52987,840 @@ } } }, - "400": { - "description": "Bad Request", + "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" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update enterprise pattern configurations", + "description": "Updates the secret scanning pattern configurations for an enterprise.\n\nPersonal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-enterprise-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, + "/enterprises/{enterprise}/settings/billing/actions": { + "get": { + "summary": "Get GitHub Actions billing for an enterprise", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nThe authenticated user must be an enterprise admin.\n\n> [!NOTE]\n> This endpoint is available to enterprise customers who are using the legacy billing platform.", + "operationId": "billing/get-github-actions-billing-ghe", + "tags": [ + "billing" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-actions-billing-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_minutes_used": { + "type": "integer", + "description": "The sum of the free and paid GitHub Actions minutes used." + }, + "total_paid_minutes_used": { + "type": "integer", + "description": "The total paid GitHub Actions minutes used." + }, + "included_minutes": { + "type": "integer", + "description": "The amount of free GitHub Actions minutes available." + }, + "minutes_used_breakdown": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "integer", + "description": "Total minutes used on Ubuntu runner machines." + }, + "MACOS": { + "type": "integer", + "description": "Total minutes used on macOS runner machines." + }, + "WINDOWS": { + "type": "integer", + "description": "Total minutes used on Windows runner machines." + }, + "ubuntu_4_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 4 core runner machines." + }, + "ubuntu_8_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 8 core runner machines." + }, + "ubuntu_16_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 16 core runner machines." + }, + "ubuntu_32_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 32 core runner machines." + }, + "ubuntu_64_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 64 core runner machines." + }, + "windows_4_core": { + "type": "integer", + "description": "Total minutes used on Windows 4 core runner machines." + }, + "windows_8_core": { + "type": "integer", + "description": "Total minutes used on Windows 8 core runner machines." + }, + "windows_16_core": { + "type": "integer", + "description": "Total minutes used on Windows 16 core runner machines." + }, + "windows_32_core": { + "type": "integer", + "description": "Total minutes used on Windows 32 core runner machines." + }, + "windows_64_core": { + "type": "integer", + "description": "Total minutes used on Windows 64 core runner machines." + }, + "macos_12_core": { + "type": "integer", + "description": "Total minutes used on macOS 12 core runner machines." + }, + "total": { + "type": "integer", + "description": "Total minutes used on all runner machines." + } + } + } + }, + "required": [ + "total_minutes_used", + "total_paid_minutes_used", + "included_minutes", + "minutes_used_breakdown" + ] + }, + "examples": { + "default": { + "value": { + "total_minutes_used": 305, + "total_paid_minutes_used": 0, + "included_minutes": 3000, + "minutes_used_breakdown": { + "UBUNTU": 205, + "MACOS": 10, + "WINDOWS": 90 + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" + } + } + }, + "/enterprises/{enterprise}/settings/billing/advanced-security": { + "get": { + "summary": "Get GitHub Advanced Security active committers for an enterprise", + "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-advanced-security-billing-ghe", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "advanced_security_product", + "in": "query", + "description": "The security product to get GitHub Advanced Security active committers for.\n\nFor standalone Code Scanning or Secret Protection products, this parameter is required to specify which product you want committer information for. For other plans this parameter cannot be used.\n", + "required": false, + "schema": { + "type": "string", + "enum": [ + "code_security", + "secret_protection" + ] + } + }, + { + "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": "Success", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_advanced_security_committers": { + "type": "integer", + "example": 25 + }, + "total_count": { + "type": "integer", + "example": 2 + }, + "maximum_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" + }, + "purchased_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences purchased" + }, + "repositories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "advanced_security_committers": { + "type": "integer", + "example": 25 + }, + "advanced_security_committers_breakdown": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user_login": { + "type": "string" + }, + "last_pushed_date": { + "type": "string", + "example": "2021-11-03" + }, + "last_pushed_email": { + "type": "string", + "example": "monalisa@github.com" + } + }, + "required": [ + "user_login", + "last_pushed_date", + "last_pushed_email" + ] + } + } + }, + "required": [ + "name", + "advanced_security_committers", + "advanced_security_committers_breakdown" + ] + } + } + }, + "required": [ + "repositories" + ] + }, + "examples": { + "default": { + "value": { + "total_advanced_security_committers": 2, + "total_count": 2, + "maximum_advanced_security_committers": 4, + "purchased_advanced_security_committers": 4, + "repositories": [ + { + "name": "octocat-org/Hello-World", + "advanced_security_committers": 2, + "advanced_security_committers_breakdown": [ + { + "user_login": "octocat", + "last_pushed_date": "2021-11-03", + "last_pushed_email": "octocat@github.com" + }, + { + "user_login": "octokitten", + "last_pushed_date": "2021-10-25", + "last_pushed_email": "octokitten@github.com" + } + ] + }, + { + "name": "octocat-org/server", + "advanced_security_committers": 1, + "advanced_security_committers_breakdown": [ + { + "user_login": "octokitten", + "last_pushed_date": "2021-10-26", + "last_pushed_email": "octokitten@github.com" + } + ] + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" + } + } + }, + "/enterprises/{enterprise}/settings/billing/cost-centers": { + "get": { + "summary": "Get all cost centers for an enterprise", + "description": "Gets a list of all the cost centers for an enterprise.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-cost-centers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response when getting cost centers", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "costCenters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the cost center." + }, + "name": { + "type": "string", + "description": "Name of the cost center." + }, + "state": { + "type": "string", + "description": "State of the cost center.", + "enum": [ + "active", + "deleted" + ] + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the resource." + }, + "name": { + "type": "string", + "description": "Name of the resource." + } + }, + "required": [ + "type", + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "resources" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "costCenters": [ + { + "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002", + "name": "Cost Center Name", + "state": "active", + "resources": [ + { + "type": "User", + "name": "Monalisa" + }, + { + "type": "Repo", + "name": "octocat/hello-world" + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -57216,6 +58869,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -72356,6 +74033,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -78132,6 +79833,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -82048,17 +83773,17 @@ "deprecated": true } }, - "/organizations/{org}/dependabot/repository-access": { + "/organizations/{org}/actions/permissions/artifact-and-log-retention": { "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.", + "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": [ - "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/permissions#get-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -82069,29 +83794,6 @@ "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": { @@ -82100,523 +83802,28 @@ "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": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal", - "nullable": true + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" }, - "accessible_repositories": { - "type": "array", - "items": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "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" - ], - "nullable": true - } + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" } }, - "additionalProperties": false + "required": [ + "days", + "maximum_allowed_days" + ] }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "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" - } - ] + "days": 90, + "maximum_allowed_days": 365 } } } @@ -82677,22 +83884,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } }, - "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```", + "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": [ - "dependabot" + "actions" ], - "operationId": "dependabot/update-repository-access-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/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -82712,50 +83918,19 @@ "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." + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" } }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } + "required": [ + "days" + ] }, "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", + "application/json": { "value": { - "repository_ids_to_remove": [ - 789 - ] + "days": 100 } } } @@ -82764,7 +83939,7 @@ }, "responses": { "204": { - "description": "Response" + "description": "No content" }, "403": { "description": "Forbidden", @@ -82817,77 +83992,9 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" - } - } - }, - "/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": [ - "dependabot" - ], - "operationId": "dependabot/set-repository-access-default-level", - "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" - }, - "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": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal" - } - }, - "required": [ - "default_level" - ] - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", - "value": { - "default_level": "public" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -82912,14 +84019,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -82927,11 +84038,50 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -82940,24 +84090,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } } }, - "/organizations/{org}/settings/billing/usage": { + "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { "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).\"", + "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": [ - "billing" + "actions" ], - "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" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -82968,144 +84117,42 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { "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" - ] - } + "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": { - "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" - } - ] + "approval_policy": "first_time_contributors" } } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83127,45 +84174,44 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83190,14 +84236,18 @@ } } }, - "500": { - "description": "Internal Error", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -83205,33 +84255,83 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "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" } } } @@ -83239,24 +84339,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "billing", - "subcategory": "enhanced-billing" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}": { + "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { "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 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": [ - "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-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -83275,446 +84374,65 @@ "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", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true, - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "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", - "nullable": true - }, - "default_repository_branch": { - "type": "string", - "example": "main", - "nullable": true, - "description": "The default branch for repositories created in this organization." - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_delete_repositories": { - "type": "boolean", - "example": true - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "example": true - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "example": true - }, - "members_can_delete_issues": { - "type": "boolean", - "example": true - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "example": true - }, - "readers_can_create_discussions": { - "type": "boolean", - "example": true - }, - "members_can_create_teams": { - "type": "boolean", - "example": true - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { + "run_workflows_from_fork_pull_requests": { "type": "boolean", - "example": false, - "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.", - "deprecated": true + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "secret_scanning_push_protection_custom_link_enabled": { + "send_write_tokens_to_workflows": { "type": "boolean", - "example": false, - "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", - "example": "https://github.com/test-org/test-repo/blob/main/README.md", - "nullable": true, - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "secret_scanning_validity_checks_enabled": { + "send_secrets_and_variables": { "type": "boolean", - "example": false, - "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 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "deploy_keys_enabled_for_repositories": { + "require_approval_for_fork_pr_workflows": { "type": "boolean", - "example": false, - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } - }, - "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": { + "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 + "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": { + "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" } } } @@ -83749,22 +84467,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "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 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": [ - "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-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -83778,176 +84495,40 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], "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", - "example": "\"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": { + "run_workflows_from_fork_pull_requests": { "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 + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "secret_scanning_push_protection_custom_link_enabled": { + "send_write_tokens_to_workflows": { "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "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": { + "send_secrets_and_variables": { "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 + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "deploy_keys_enabled_for_repositories": { + "require_approval_for_fork_pr_workflows": { "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } } }, "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" + "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 } } } @@ -83955,561 +84536,73 @@ } }, "responses": { - "200": { - "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": "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.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true, - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "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", - "nullable": true - }, - "default_repository_branch": { - "type": "string", - "example": "main", - "nullable": true, - "description": "The default branch for repositories created in this organization." - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_delete_repositories": { - "type": "boolean", - "example": true - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "example": true - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "example": true - }, - "members_can_delete_issues": { - "type": "boolean", - "example": true - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "example": true - }, - "readers_can_create_discussions": { - "type": "boolean", - "example": true - }, - "members_can_create_teams": { - "type": "boolean", - "example": true - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "example": false, - "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", - "example": "https://github.com/test-org/test-repo/blob/main/README.md", - "nullable": true, - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." - }, - "secret_scanning_validity_checks_enabled": { - "type": "boolean", - "example": false, - "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 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true + "type": "string" }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "example": false, - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." - } - }, - "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 + "status": { + "type": "string" } } } } } }, - "422": { - "description": "Validation failed", + "404": { + "description": "Resource not found", "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -84517,11 +84610,50 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -84530,22 +84662,23 @@ } }, "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", + } + }, + "/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": [ - "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#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -84559,23 +84692,45 @@ } ], "responses": { - "202": { - "description": "Accepted", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "type": "object" + "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": { - "default": { - "value": null + "response": { + "summary": "Example response", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } } } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -84600,8 +84755,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -84628,24 +84783,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } - } - }, - "/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.", + }, + "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" ], - "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#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -84658,67 +84810,207 @@ } } ], + "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": { - "200": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_active_caches_count": { - "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." + "message": { + "type": "string" }, - "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." + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - }, - "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 + } + } + } + } + }, + "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" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "409": { + "description": "Conflict", + "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" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/cache/usage-by-repository": { + "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { "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.", + "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" ], - "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#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -84756,304 +85048,739 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repository_cache_usages" - ], "properties": { "total_count": { "type": "integer" }, - "repository_cache_usages": { + "repositories": { "type": "array", "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { "type": "string", - "example": "octo-org/Hello-World" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer", - "example": 2322142 + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "example": 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": "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", + "full_name": { "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 + "example": "octocat/Hello-World" }, - "image_details": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "key": { "type": "string", - "example": "ubuntu-20.04" + "example": "mit" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "name": { + "type": "string", + "example": "MIT License" }, - "display_name": { - "description": "Display name for this image.", + "url": { "type": "string", - "example": 20.04 + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "source": { - "description": "The image provider.", + "spdx_id": { "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "id", - "size_gb", - "display_name", - "source" + "key", + "name", + "url", + "spdx_id", + "node_id" ], "nullable": true }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "example": "8-core" + "example": "octocat" }, - "cpu_cores": { - "description": "The number of cores.", + "id": { "type": "integer", - "example": 8 + "format": "int64", + "example": 1 }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "cpu_cores", - "memory_gb", - "storage_gb" + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "status": { - "description": "The status of the runner.", + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "platform": { - "description": "The operating system of the image.", + "description": { "type": "string", - "example": "linux-x64" + "example": "This your first repo!", + "nullable": true }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { "type": "integer", - "default": 10, - "example": 5 + "example": 9 }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, "type": "boolean", "example": true }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "topics": { "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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } + "type": "string" } }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": "string", "format": "date-time", - "example": "2022-10-09T23:39:01Z", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" + "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" ] } } @@ -85062,89 +85789,207 @@ "examples": { "default": { "value": { - "total_count": 2, - "runners": [ + "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 + "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 }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } + "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" ], - "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 + "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 }, - "machine_size_details": { - "id": "8-core", - "cpu_cores": 8, - "memory_gb": 32, - "storage_gb": 300 + "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" }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" + "forks": 1, + "open_issues": 1, + "watchers": 1 } ] } } } } - }, - "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 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/hosted-runners#create-a-github-hosted-runner-for-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": [ { @@ -85163,66 +86008,27 @@ "application/json": { "schema": { "type": "object", + "required": [ + "selected_repository_ids" + ], "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" + "selected_repository_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" } - }, - "required": [ - "name", - "image", - "size", - "runner_group_id" - ] + } }, "examples": { - "default": { + "application/json": { "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 + "selected_repository_ids": [ + 1, + 2, + 3 + ] } } } @@ -85230,336 +86036,149 @@ } }, "responses": { - "201": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 + "message": { + "type": "string" }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true + "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "url": { + "type": "string" }, "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": true + "documentation_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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } + "url": { + "type": "string" }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" + "status": { + "type": "string" } } } } } - } - }, - "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", + }, + "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", - "images" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "images": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", "type": "object", + "required": [ + "code" + ], "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" + "resource": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" + "field": { + "type": "string" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "message": { + "type": "string" }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 + "code": { + "type": "string" }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } ] } - }, - "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" + "subcategory": "permissions" } } }, - "/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", + "/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/hosted-runners#get-partner-images-for-github-hosted-runners-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": [ { @@ -85570,105 +86189,185 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", + "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" + } + } + } + } + } + }, + "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": [ - "total_count", - "images" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "images": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", "type": "object", + "required": [ + "code" + ], "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" + "resource": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" + "field": { + "type": "string" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "message": { + "type": "string" }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 + "code": { + "type": "string" }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } ] } - }, - "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" + "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", + }, + "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/hosted-runners#get-limits-on-github-hosted-runners-for-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": [ { @@ -85679,242 +86378,187 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "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.", - "example": 50 - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "example": 17 - } - }, - "required": [ - "maximum", - "current_usage" - ] - } - }, - "required": [ - "public_ips" - ] - }, - "examples": { - "default": { - "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "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", + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "machine_specs" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 + } + } + } + }, + "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": "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/enterprise-cloud@latest//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", + }, + "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", - "platforms" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "platforms": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "/organizations/{org}/dependabot/repository-access": { "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": "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": "actions/get-hosted-runner-for-org", + "operationId": "dependabot/repository-access-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/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -85927,12 +86571,26 @@ } }, { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, "schema": { - "type": "integer" + "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 } } ], @@ -85942,1250 +86600,47 @@ "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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": "hosted-runners" - } - }, - "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/hosted-runners#update-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" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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" - } - } - }, - "examples": { - "default": { - "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.", + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", + "default_level": { "type": "string", - "example": "Ready", + "description": "The default repository access level for Dependabot updates.", "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "hosted-runners" - } - }, - "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": [ - "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" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "202": { - "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" + "public", + "internal" ], + "example": "internal", "nullable": true }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" - } - } - } - } - } - } - }, - "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", - "content": { - "application/json": { - "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", - "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" - } - } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "oidc" - } - }, - "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.", - "tags": [ - "oidc" - ], - "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" - }, - "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": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", - "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" - } - } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Empty response", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "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": { - "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", - "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" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." - }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] - }, - "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" - } - } - } - } - } - } - }, - "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": { - "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", - "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" - }, - "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", - "repositories" - ], - "properties": { - "total_count": { - "type": "number" - }, - "repositories": { + "accessible_repositories": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "example": 42, "type": "integer", - "format": "int64" + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." }, "name": { - "description": "The name of the repository.", "type": "string", - "example": "Team Environment" + "example": "Hello-World", + "description": "The name of the repository." }, "full_name": { "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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" - ] + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", @@ -87312,438 +86767,223 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true + "nullable": true, + "description": "The repository description." }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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" - } - } + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." } }, "required": [ @@ -87792,57 +87032,34 @@ "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" - ] + "url" + ], + "nullable": true } } - } + }, + "additionalProperties": false }, "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "default_level": "public", + "accessible_repositories": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", + "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://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", + "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", + "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}", @@ -87853,105 +87070,51 @@ "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 + "site_admin": false, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" }, "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", "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 + "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" } ] } @@ -87959,25 +87122,77 @@ } } } + }, + "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" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" } }, - "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", + "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-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -87990,11 +87205,6 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { "required": true, "content": { @@ -88002,25 +87212,49 @@ "schema": { "type": "object", "properties": { - "selected_repository_ids": { - "description": "List of repository IDs to enable for GitHub Actions.", + "repository_ids_to_add": { "type": "array", "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } + "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": [ - "selected_repository_ids" - ] + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } }, "examples": { - "default": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", "value": { - "selected_repository_ids": [ - 32, - 42 + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 ] } } @@ -88028,183 +87262,82 @@ } } }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { - "put": { - "summary": "Enable a selected repository for GitHub Actions in an organization", - "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\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/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" } - }, - "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", + } + }, + "/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/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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", - "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": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - } - } - } - } - } - } - }, - "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" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -88217,184 +87350,89 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { - "required": false, + "required": true, "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": { - "type": "string" - } + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal" } - } + }, + "required": [ + "default_level" + ] }, "examples": { - "selected_actions": { + "204": { + "summary": "Example with a 'succeeded' status.", "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + "default_level": "public" } } } } } }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/orgs/{org}/actions/permissions/workflow": { - "get": { - "summary": "Get default workflow permissions for an organization", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-github-actions-default-workflow-permissions-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-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", + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] + "message": { + "type": "string" }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - }, - "required": [ - "default_workflow_permissions", - "can_approve_pull_request_reviews" - ] - }, - "examples": { - "default": { - "summary": "Give read-only permission, and allow approving PRs.", - "value": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set default workflow permissions for an organization", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/set-github-actions-default-workflow-permissions-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-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": "Success response" }, - "409": { - "description": "Conflict response when changing a setting is prevented by the owning enterprise" - } - }, - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] - }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - } - }, - "examples": { - "default": { - "summary": "Give read-only permission, and allow approving PRs.", - "value": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true + "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" + } } } } @@ -88404,22 +87442,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/orgs/{org}/actions/runner-groups": { + "/organizations/{org}/settings/billing/usage": { "get": { - "summary": "List self-hosted runner groups for an organization", - "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-self-hosted-runner-groups-for-org", + "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/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" }, "parameters": [ { @@ -88432,116 +87470,111 @@ } }, { - "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).\"", + "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", - "default": 30 + "type": "integer" } }, { - "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).\"", + "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", - "default": 1 + "type": "integer" } }, { - "name": "visible_to_repository", - "description": "Only return runner groups that are allowed to be used by this repository.", + "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": "string" + "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": [ - "total_count", - "runner_groups" - ], "properties": { - "total_count": { - "type": "number" - }, - "runner_groups": { + "usageItems": { "type": "array", "items": { "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" + "date": { + "type": "string", + "description": "Date of the usage line item." }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "product": { + "type": "string", + "description": "Product name." }, - "runners_url": { - "type": "string" + "sku": { + "type": "string", + "description": "SKU name." }, - "hosted_runners_url": { - "type": "string" + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." }, - "inherited": { - "type": "boolean" + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." }, - "inherited_allows_public_repositories": { - "type": "boolean" + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." }, - "allows_public_repositories": { - "type": "boolean" + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false + "organizationName": { + "type": "string", + "description": "Name of the organization." }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "repositoryName": { + "type": "string", + "description": "Name of the repository." } }, "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" ] } } @@ -88550,48 +87583,19 @@ "examples": { "default": { "value": { - "total_count": 3, - "runner_groups": [ - { - "id": 1, - "name": "Default", - "visibility": "all", - "default": true, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [], - "workflow_restrictions_read_only": false - }, - { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "inherited": true, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": true - }, + "usageItems": [ { - "id": 3, - "name": "expensive-hardware", - "visibility": "private", - "default": false, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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" } ] } @@ -88599,212 +87603,134 @@ } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - }, - "post": { - "summary": "Create a self-hosted runner group for an organization", - "description": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/create-self-hosted-runner-group-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-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 group.", - "type": "string" - }, - "visibility": { - "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "type": "string", - "enum": [ - "selected", - "all", - "private" - ], - "default": "all" - }, - "selected_repository_ids": { - "description": "List of repository IDs that can access the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } - }, - "runners": { - "description": "List of runner IDs to add to the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - } - }, - "allows_public_repositories": { - "description": "Whether the runner group can be used by `public` repositories.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + }, + "400": { + "description": "Bad Request", + "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" } - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" } - }, - "required": [ - "name" - ] + } }, - "examples": { - "default": { - "value": { - "name": "Expensive hardware runners", - "visibility": "selected", - "selected_repository_ids": [ - 32, - 91 - ], - "runners": [ - 9, - 2 - ] + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } } } } } - } - }, - "responses": { - "201": { - "description": "Response", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { + "message": { "type": "string" }, - "visibility": { + "documentation_url": { "type": "string" }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "url": { "type": "string" }, - "runners_url": { + "status": { "type": "string" - }, - "hosted_runners_url": { + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { "type": "string" }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", + "documentation_url": { "type": "string" }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" + "url": { + "type": "string" }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false + "message": { + "type": "string" }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - }, - "examples": { - "default": { - "value": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "documentation_url": { + "type": "string" } } } @@ -88813,24 +87739,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "/orgs/{org}": { "get": { - "summary": "Get a self-hosted runner group for an organization", - "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-self-hosted-runner-group-for-org", + "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/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -88841,15 +87767,6 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -88858,91 +87775,472 @@ "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", + "example": "github" + }, "id": { - "type": "number" + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, "name": { - "type": "string" + "type": "string", + "example": "github" }, - "visibility": { - "type": "string" + "company": { + "type": "string", + "example": "GitHub" }, - "default": { - "type": "boolean" + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "location": { + "type": "string", + "example": "San Francisco" }, - "runners_url": { - "type": "string" + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" }, - "hosted_runners_url": { - "type": "string" + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "is_verified": { + "type": "boolean", + "example": true }, - "inherited": { - "type": "boolean" + "has_organization_projects": { + "type": "boolean", + "example": true }, - "inherited_allows_public_repositories": { - "type": "boolean" + "has_repository_projects": { + "type": "boolean", + "example": true }, - "allows_public_repositories": { - "type": "boolean" + "public_repos": { + "type": "integer", + "example": 2 }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "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", + "nullable": true + }, + "default_repository_branch": { + "type": "string", + "example": "main", + "nullable": true, + "description": "The default branch for repositories created in this organization." + }, + "members_can_create_repositories": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "two_factor_requirement_enabled": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_delete_repositories": { + "type": "boolean", + "example": true + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "example": true + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "example": true + }, + "members_can_delete_issues": { + "type": "boolean", + "example": true + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "example": true + }, + "readers_can_create_discussions": { + "type": "boolean", + "example": true + }, + "members_can_create_teams": { + "type": "boolean", + "example": true + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "example": false, + "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", + "example": "https://github.com/test-org/test-repo/blob/main/README.md", + "nullable": true, + "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + }, + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "example": false, + "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 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ + "login", + "url", "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "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": { + "default-response": { "value": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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" } } } @@ -88951,22 +88249,22 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" } }, "patch": { - "summary": "Update a self-hosted runner group for an organization", - "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/update-self-hosted-runner-group-for-org", + "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": [ - "actions" + "orgs" ], + "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -88977,71 +88275,179 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { - "required": true, + "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": { - "description": "Name of the runner group.", - "type": "string" + "type": "string", + "description": "The shorthand name of the company." }, - "visibility": { - "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", + "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": [ - "selected", "all", - "private" + "private", + "none" ] }, - "allows_public_repositories": { - "description": "Whether the runner group can be used by `public` repositories.", + "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 }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "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 }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "blog": { + "type": "string", + "example": "\"http://github.blog\"" }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", + "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", - "nullable": true + "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": [ - "name" - ] + } }, "examples": { "default": { "value": { - "name": "Expensive hardware runners", - "visibility": "selected" + "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" } } } @@ -89054,160 +88460,765 @@ "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", + "example": "github" + }, "id": { - "type": "number" + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, "name": { - "type": "string" + "type": "string", + "example": "github" }, - "visibility": { - "type": "string" + "company": { + "type": "string", + "example": "GitHub" }, - "default": { - "type": "boolean" + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "location": { + "type": "string", + "example": "San Francisco" }, - "runners_url": { - "type": "string" + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" }, - "hosted_runners_url": { - "type": "string" + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "is_verified": { + "type": "boolean", + "example": true }, - "inherited": { - "type": "boolean" + "has_organization_projects": { + "type": "boolean", + "example": true }, - "inherited_allows_public_repositories": { - "type": "boolean" + "has_repository_projects": { + "type": "boolean", + "example": true }, - "allows_public_repositories": { - "type": "boolean" + "public_repos": { + "type": "integer", + "example": 2 }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "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", + "nullable": true + }, + "default_repository_branch": { + "type": "string", + "example": "main", + "nullable": true, + "description": "The default branch for repositories created in this organization." + }, + "members_can_create_repositories": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "two_factor_requirement_enabled": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_delete_repositories": { + "type": "boolean", + "example": true + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "example": true + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "example": true + }, + "members_can_delete_issues": { + "type": "boolean", + "example": true + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "example": true + }, + "readers_can_create_discussions": { + "type": "boolean", + "example": true + }, + "members_can_create_teams": { + "type": "boolean", + "example": true + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "example": false, + "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", + "example": "https://github.com/test-org/test-repo/blob/main/README.md", + "nullable": true, + "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + }, + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "example": false, + "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 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ + "login", + "url", "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "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": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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 } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - }, - "delete": { - "summary": "Delete a self-hosted runner group from an organization", - "description": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/delete-self-hosted-runner-group-from-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - } - }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": "List GitHub-hosted runners in a group for an organization", - "description": "Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-github-hosted-runners-in-group-for-org", + "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/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + "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": [ { @@ -89220,12 +89231,130 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", + "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", + "example": "octo-org/Hello-World" + }, + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", + "example": 2322142 + }, + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", + "example": 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": "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": "integer" + "type": "string" } }, { @@ -89260,7 +89389,7 @@ ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "runners": { "type": "array", @@ -89500,24 +89629,22 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - } - }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { - "get": { - "summary": "List repository access to a self-hosted runner group in an organization", - "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + }, + "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/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -89528,994 +89655,276 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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 - } - }, - { - "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 - } } ], + "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": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "number" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 }, - "repositories": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true }, - "role_name": { + "prefix": { + "description": "The prefix for the public IP.", "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 + "example": "20.80.208.150" }, - "watchers": { + "length": { + "description": "The length of the IP prefix.", "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "example": 28 } - }, - "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" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true } - } + }, + "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 - }, - "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 - }, - "template_repository": { - "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", - "organization": null, - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "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 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": 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==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 } - ] + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -90527,19 +89936,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "put": { - "summary": "Set repository access for a self-hosted runner group in an organization", - "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", + } + }, + "/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/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -90550,74 +89961,105 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "description": "List of repository IDs that can access the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." + "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", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } } } }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 32, - 91 - ] + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { - "put": { - "summary": "Add repository access to a self-hosted runner group in an organization", - "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "/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/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -90628,48 +90070,105 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "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", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 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" + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "delete": { - "summary": "Remove repository access to a self-hosted runner group in an organization", - "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", + } + }, + "/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/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-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": [ { @@ -90680,50 +90179,75 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "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.", + "example": 50 + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "example": 17 + } + }, + "required": [ + "maximum", + "current_usage" + ] + } + }, + "required": [ + "public_ips" + ] + }, + "examples": { + "default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "/orgs/{org}/actions/hosted-runners/machine-sizes": { "get": { - "summary": "List self-hosted runners in a group for an organization", - "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "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/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" }, "parameters": [ { @@ -90734,33 +90258,6 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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": { @@ -90772,87 +90269,45 @@ "type": "object", "required": [ "total_count", - "runners" + "machine_specs" ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, - "runners": { + "machine_specs": { "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "example": "8-core" }, - "runner_group_id": { - "description": "The ID of the runner group.", + "cpu_cores": { + "description": "The number of cores.", "type": "integer", - "example": 1 + "example": 8 }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 } }, "required": [ "id", - "name", - "os", - "status", - "busy", - "labels" + "cpu_cores", + "memory_gb", + "storage_gb" ] } } @@ -90861,96 +90316,36 @@ "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] - }, - { - "id": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - ] + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "put": { - "summary": "Set self-hosted runners in a group for an organization", - "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-in-group-for-org", + } + }, + "/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/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -90961,74 +90356,65 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "runners": { - "description": "List of runner IDs to add to the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." + "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" + } } } }, - "required": [ - "runners" - ] - }, - "examples": { - "default": { - "value": { - "runners": [ - 9, - 2 - ] + "examples": { + "default": { + "value": { + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { - "put": { - "summary": "Add a self-hosted runner to a group for an organization", - "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/add-self-hosted-runner-to-group-for-org", + "/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/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -91041,17 +90427,8 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -91060,27 +90437,233 @@ } ], "responses": { - "204": { - "description": "Response" + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } }, - "delete": { - "summary": "Remove a self-hosted runner from a group for an organization", - "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/remove-self-hosted-runner-from-group-for-org", + "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/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -91093,17 +90676,8 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -91111,40 +90685,266 @@ } } ], + "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" + } + } + }, + "examples": { + "default": { + "value": { + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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" + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - } - }, - "/orgs/{org}/actions/runners": { - "get": { - "summary": "List self-hosted runners for an organization", - "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + }, + "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": [ "actions" ], - "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ - { - "name": "name", - "description": "The name of a self-hosted runner.", - "in": "query", - "schema": { - "type": "string" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -91155,214 +90955,237 @@ } }, { - "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", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], "responses": { - "200": { + "202": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "total_count", - "runners" - ], "properties": { - "total_count": { - "type": "integer" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 }, - "runners": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true }, - "status": { - "description": "The status of the runner.", + "prefix": { + "description": "The prefix for the public IP.", "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } + "example": "20.80.208.150" }, - "ephemeral": { - "type": "boolean" + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true } - } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] }, "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] - }, + "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": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] + "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, + "enabledForGitHubApps": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runners/downloads": { + "/orgs/{org}/actions/oidc/customization/sub": { "get": { - "summary": "List runner applications for an organization", - "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "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": [ - "actions" + "oidc" ], - "operationId": "actions/list-runner-applications-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/actions/self-hosted-runners#list-runner-applications-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": [ { @@ -91377,78 +91200,34 @@ ], "responses": { "200": { - "description": "Response", + "description": "A JSON serialized template for OIDC subject claim customization", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Runner Application", - "description": "Runner Application", - "type": "object", - "properties": { - "os": { - "type": "string" - }, - "architecture": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "filename": { - "type": "string" - }, - "temp_download_token": { - "description": "A short lived bearer token used to download the runner, if needed.", - "type": "string" - }, - "sha256_checksum": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", + "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" } - }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] - } + } + }, + "required": [ + "include_claim_keys" + ] }, "examples": { "default": { - "value": [ - { - "os": "osx", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", - "filename": "actions-runner-osx-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", - "filename": "actions-runner-linux-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "arm", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm-2.164.0.tar.gz" - }, - { - "os": "win", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", - "filename": "actions-runner-win-x64-2.164.0.zip" - }, - { - "os": "linux", - "architecture": "arm64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" - } - ] + "value": { + "include_claim_keys": [ + "repo", + "context" + ] + } } } } @@ -91456,24 +91235,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "oidc" } - } - }, - "/orgs/{org}/actions/runners/generate-jitconfig": { - "post": { - "summary": "Create configuration for a just-in-time runner for an organization", - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + }, + "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.", "tags": [ - "actions" + "oidc" ], - "operationId": "actions/generate-runner-jitconfig-for-org", + "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -91491,49 +91267,29 @@ "content": { "application/json": { "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", - "required": [ - "name", - "runner_group_id", - "labels" - ], "properties": { - "name": { - "type": "string", - "description": "The name of the new runner." - }, - "runner_group_id": { - "type": "integer", - "description": "The ID of the runner group to register the runner to." - }, - "labels": { + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", "type": "array", - "minItems": 1, - "maxItems": 100, "items": { "type": "string" - }, - "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." - }, - "work_folder": { - "type": "string", - "description": "The working directory to be used for job execution, relative to the runner install directory.", - "default": "_work" + } } - } + }, + "required": [ + "include_claim_keys" + ] }, "examples": { "default": { "value": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -91542,131 +91298,19 @@ }, "responses": { "201": { - "description": "Response", + "description": "Empty response", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "required": [ - "runner", - "encoded_jit_config" - ], - "properties": { - "runner": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - }, - "encoded_jit_config": { - "type": "string", - "description": "The base64 encoded runner configuration." - } - } + "properties": {}, + "additionalProperties": false }, "examples": { "default": { - "value": { - "runner": { - "id": 23, - "name": "New runner", - "os": "unknown", - "status": "offline", - "busy": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - }, - "encoded_jit_config": "abc123" - } + "value": null } } } @@ -91698,18 +91342,14 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -91717,37 +91357,94 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - }, - "409": { - "description": "Conflict", + } + }, + "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", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" + "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" + ] }, - "documentation_url": { - "type": "string" + "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`." }, - "url": { - "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" + ] }, - "status": { - "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" } } } @@ -91756,24 +91453,99 @@ } }, "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": "self-hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runners/registration-token": { - "post": { - "summary": "Create a registration token for an organization", - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/orgs/{org}/actions/permissions/repositories": { + "get": { + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\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" ], - "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -91784,38 +91556,42 @@ "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": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", + "required": [ + "total_count", + "repositories" + ], "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "example": "v1.1f699f1069f60xxx" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "example": "2016-07-11T22:14:10Z" - }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - } + "total_count": { + "type": "number" }, "repositories": { - "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", @@ -92546,57 +92322,319 @@ "updated_at" ] } - }, - "single_file": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] } - }, - "required": [ - "token", - "expires_at" - ] + } }, "examples": { "default": { "value": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" + "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 + } + ] + } + } + } + } + } + } + }, + "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", + "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" + }, + "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": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." } } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] + } } } } } }, "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\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/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "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", + "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" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runners/remove-token": { - "post": { - "summary": "Create a remove token for an organization", - "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/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" ], - "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -92610,139 +92648,1463 @@ } ], "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "example": "v1.1f699f1069f60xxx" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "example": "2016-07-11T22:14:10Z" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - } + "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." }, - "repositories": { - "description": "The repositories this token has access to", + "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": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "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": { + "type": "string" + } + } + } + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/workflow": { + "get": { + "summary": "Get default workflow permissions for an organization", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-github-actions-default-workflow-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-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": { + "default_workflow_permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] + }, + "can_approve_pull_request_reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + } + }, + "required": [ + "default_workflow_permissions", + "can_approve_pull_request_reviews" + ] + }, + "examples": { + "default": { + "summary": "Give read-only permission, and allow approving PRs.", + "value": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set default workflow permissions for an organization", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-github-actions-default-workflow-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-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": "Success response" + }, + "409": { + "description": "Conflict response when changing a setting is prevented by the owning enterprise" + } + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_workflow_permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] + }, + "can_approve_pull_request_reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + } + } + }, + "examples": { + "default": { + "summary": "Give read-only permission, and allow approving PRs.", + "value": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an organization", + "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runner-groups-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-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 + } + }, + { + "name": "visible_to_repository", + "description": "Only return runner groups that are allowed to be used by this repository.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runner_groups" + ], + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [], + "workflow_restrictions_read_only": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": true, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "post": { + "summary": "Create a self-hosted runner group for an organization", + "description": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-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 group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an organization", + "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "patch": { + "summary": "Update a self-hosted runner group for an organization", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ] + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an organization", + "description": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + "get": { + "summary": "List GitHub-hosted runners in a group for an organization", + "description": "Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-github-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": "number" + }, + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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 + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + "get": { + "summary": "List repository access to a self-hosted runner group in an organization", + "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, "email": { "nullable": true, "type": "string" @@ -92859,8 +94221,6 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -92955,8 +94315,7 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "type": "string" }, "issue_comment_url": { "type": "string", @@ -93005,8 +94364,7 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "type": "string" }, "stargazers_url": { "type": "string", @@ -93042,13 +94400,10 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "type": "string" }, "mirror_url": { "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -93057,14 +94412,10 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "type": "string" }, "homepage": { "type": "string", - "format": "uri", - "example": "https://github.com", "nullable": true }, "language": { @@ -93072,36 +94423,26 @@ "nullable": true }, "forks_count": { - "type": "integer", - "example": 9 + "type": "integer" }, "stargazers_count": { - "type": "integer", - "example": 80 + "type": "integer" }, "watchers_count": { - "type": "integer", - "example": 80 + "type": "integer" }, "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", - "example": 108 + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" + "type": "string" }, "open_issues_count": { - "type": "integer", - "example": 0 + "type": "integer" }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true + "type": "boolean" }, "topics": { "type": "array", @@ -93110,51 +94451,30 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true + "type": "boolean" }, "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true + "type": "boolean" }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "type": "boolean" }, "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", "type": "string" }, "pushed_at": { @@ -93175,122 +94495,226 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" }, "temp_clone_token": { "type": "string" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false + "type": "boolean" }, - "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", - "example": false + "subscribers_count": { + "type": "integer" }, - "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 + "network_count": { + "type": "integer" }, - "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)." + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] }, - "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." + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true }, - "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)." + "forks": { + "type": "integer", + "example": 0 }, - "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." + "open_issues": { + "type": "integer", + "example": 0 }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true + "watchers": { + "type": "integer", + "example": 0 }, "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", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "example": false }, - "code_search_index_status": { + "security_and_analysis": { + "nullable": true, "type": "object", - "description": "The status of the code search index for this repository", "properties": { - "lexical_search_ok": { - "type": "boolean" + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "lexical_commit_sha": { - "type": "string" + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -93339,292 +94763,259 @@ "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" + "url" ] } - }, - "single_file": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - } - }, - "required": [ - "token", - "expires_at" - ] - }, - "examples": { - "default": { - "value": { - "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-29T12:13:35.123-08:00" } } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/orgs/{org}/actions/runners/{runner_id}": { - "get": { - "summary": "Get a self-hosted runner for an organization", - "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/get-self-hosted-runner-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-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" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] }, "examples": { "default": { "value": { - "id": 23, - "name": "MBP", - "os": "macos", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, + "total_count": 1, + "repositories": [ { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - }, - "delete": { - "summary": "Delete a self-hosted runner from an organization", - "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-self-hosted-runner-from-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "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" - } + "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 + }, + "template_repository": { + "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", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "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 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": 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==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] } } } @@ -93633,24 +95024,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - } - }, - "/orgs/{org}/actions/runners/{runner_id}/labels": { - "get": { - "summary": "List labels for a self-hosted runner for an organization", - "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + }, + "put": { + "summary": "Set repository access for a self-hosted runner group in an organization", + "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], - "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -93663,8 +95052,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -93672,128 +95061,115 @@ } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." } } }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 91 + ] } } } } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + "put": { + "summary": "Add repository access to a self-hosted runner group in an organization", + "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "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" - } - } - } - } + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } + ], + "responses": { + "204": { + "description": "Response" + } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } }, - "post": { - "summary": "Add custom labels to a self-hosted runner for an organization", - "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "delete": { + "summary": "Remove repository access to a self-hosted runner group in an organization", + "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], - "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -93806,8 +95182,17 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { @@ -93815,40 +95200,69 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "labels" - ], - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "maxItems": 100, - "description": "The names of the custom labels to add to the runner.", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "labels": [ - "gpu", - "accelerated" - ] - } - } - } - } + "responses": { + "204": { + "description": "Response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an organization", + "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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", @@ -93858,38 +95272,87 @@ "type": "object", "required": [ "total_count", - "labels" + "runners" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "labels": { + "runners": { "type": "array", "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { "id": { + "description": "The ID of the runner.", "type": "integer", - "description": "Unique identifier of the label." + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 }, "name": { + "description": "The name of the runner.", "type": "string", - "description": "Name of the label." + "example": "iMac" }, - "type": { + "os": { + "description": "The Operating System of the runner.", "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } }, "required": [ - "name" + "id", + "name", + "os", + "status", + "busy", + "labels" ] } } @@ -93898,109 +95361,96 @@ "examples": { "default": { "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, + "total_count": 2, + "runners": [ { - "id": 20, - "name": "macOS", - "type": "read-only" + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] }, { - "id": 21, - "name": "no-gpu", - "type": "custom" + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } ] } } } } - } - }, - "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": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "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" - } - } - } + "type": "string" } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } }, "put": { - "summary": "Set custom labels for a self-hosted runner for an organization", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "Set self-hosted runners in a group for an organization", + "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-in-group-for-org", "tags": [ "actions" ], - "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -94013,8 +95463,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -94028,27 +95478,26 @@ "application/json": { "schema": { "type": "object", - "required": [ - "labels" - ], "properties": { - "labels": { + "runners": { + "description": "List of runner IDs to add to the runner group.", "type": "array", - "minItems": 0, - "maxItems": 100, - "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", "items": { - "type": "string" + "type": "integer", + "description": "Unique identifier of the runner." } } - } + }, + "required": [ + "runners" + ] }, "examples": { "default": { "value": { - "labels": [ - "gpu", - "accelerated" + "runners": [ + 9, + 2 ] } } @@ -94057,157 +95506,29 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - }, - "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 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" - } - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - }, - "delete": { - "summary": "Remove all custom labels from a self-hosted runner for an organization", - "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an organization", + "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-self-hosted-runner-to-group-for-org", "tags": [ "actions" ], - "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" }, "parameters": [ { @@ -94219,6 +95540,15 @@ "type": "string" } }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", @@ -94230,124 +95560,27 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 3, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - } - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - } - }, - "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + }, "delete": { - "summary": "Remove a custom label from a self-hosted runner for an organization", - "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "Remove a self-hosted runner from a group for an organization", + "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-self-hosted-runner-from-group-for-org", "tags": [ "actions" ], - "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" }, "parameters": [ { @@ -94360,8 +95593,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -94369,171 +95602,49 @@ } }, { - "name": "name", - "description": "The name of a self-hosted runner's custom label.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - }, - "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 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" - } - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/orgs/{org}/actions/secrets": { + "/orgs/{org}/actions/runners": { "get": { - "summary": "List organization secrets", - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "List self-hosted runners for an organization", + "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/list-org-secrets", + "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" }, "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -94571,52 +95682,87 @@ "type": "object", "required": [ "total_count", - "secrets" + "runners" ], "properties": { "total_count": { "type": "integer" }, - "secrets": { + "runners": { "type": "array", "items": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" + "description": "The name of the runner.", + "type": "string", + "example": "iMac" }, - "created_at": { + "os": { + "description": "The Operating System of the runner.", "type": "string", - "format": "date-time" + "example": "macos" }, - "updated_at": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "date-time" + "example": "online" }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" + "busy": { + "type": "boolean" }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } }, "required": [ + "id", "name", - "created_at", - "updated_at", - "visibility" + "os", + "status", + "busy", + "labels" ] } } @@ -94625,26 +95771,62 @@ "examples": { "default": { "value": { - "total_count": 3, - "secrets": [ - { - "name": "GIST_ID", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, + "total_count": 2, + "runners": [ { - "name": "DEPLOY_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] }, { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } ] } @@ -94666,21 +95848,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/public-key": { + "/orgs/{org}/actions/runners/downloads": { "get": { - "summary": "Get an organization public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "summary": "List runner applications for an organization", + "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/get-org-public-key", + "operationId": "actions/list-runner-applications-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" }, "parameters": [ { @@ -94699,48 +95881,74 @@ "content": { "application/json": { "schema": { - "title": "ActionsPublicKey", - "description": "The public key used for setting Actions Secrets.", - "type": "object", - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "example": "1234567" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - }, - "id": { - "type": "integer", - "example": 2 - }, - "url": { - "type": "string", - "example": "https://api.github.com/user/keys/2" - }, - "title": { - "type": "string", - "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + "type": "array", + "items": { + "title": "Runner Application", + "description": "Runner Application", + "type": "object", + "properties": { + "os": { + "type": "string" + }, + "architecture": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "temp_download_token": { + "description": "A short lived bearer token used to download the runner, if needed.", + "type": "string" + }, + "sha256_checksum": { + "type": "string" + } }, - "created_at": { - "type": "string", - "example": "2011-01-26T19:01:12Z" - } - }, - "required": [ - "key_id", - "key" - ] + "required": [ + "os", + "architecture", + "download_url", + "filename" + ] + } }, "examples": { "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } + "value": [ + { + "os": "osx", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", + "filename": "actions-runner-osx-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", + "filename": "actions-runner-linux-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "arm", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm-2.164.0.tar.gz" + }, + { + "os": "win", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", + "filename": "actions-runner-win-x64-2.164.0.zip" + }, + { + "os": "linux", + "architecture": "arm64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" + } + ] } } } @@ -94751,119 +95959,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/orgs/{org}/actions/runners/generate-jitconfig": { + "post": { + "summary": "Create configuration for a just-in-time runner for an organization", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/create-or-update-org-secret", + "operationId": "actions/generate-runner-jitconfig-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" }, "parameters": [ { @@ -94874,15 +95984,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -94891,49 +95992,48 @@ "application/json": { "schema": { "type": "object", + "required": [ + "name", + "runner_group_id", + "labels" + ], "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { + "name": { "type": "string", - "description": "ID of the key you used to encrypt the secret." + "description": "The name of the new runner." }, - "visibility": { - "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "enum": [ - "all", - "private", - "selected" - ] + "runner_group_id": { + "type": "integer", + "description": "The ID of the runner group to register the runner to." }, - "selected_repository_ids": { + "labels": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "minItems": 1, + "maxItems": 100, "items": { - "type": "integer" - } + "type": "string" + }, + "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." + }, + "work_folder": { + "type": "string", + "description": "The working directory to be used for job execution, relative to the runner install directory.", + "default": "_work" } - }, - "required": [ - "encrypted_value", - "key_id", - "visibility" - ] + } }, "examples": { "default": { "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" } } } @@ -94942,90 +96042,238 @@ }, "responses": { "201": { - "description": "Response when creating a secret", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } }, "examples": { "default": { - "value": null + "value": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + } } } } } }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "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" + } + } + } + } } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } } - } - ], - "responses": { - "204": { - "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/{secret_name}/repositories": { - "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "/orgs/{org}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for an organization", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/list-selected-repos-for-org-secret", + "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" }, "parameters": [ { @@ -95036,74 +96284,133 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 - } } ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } }, "repositories": { + "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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.", @@ -95229,6 +96536,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -95323,7 +96632,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string" + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", @@ -95372,7 +96682,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string" + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", @@ -95408,10 +96719,13 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string" + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -95420,10 +96734,14 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", + "format": "uri", + "example": "https://github.com", "nullable": true }, "language": { @@ -95431,26 +96749,36 @@ "nullable": true }, "forks_count": { - "type": "integer" + "type": "integer", + "example": 9 }, "stargazers_count": { - "type": "integer" + "type": "integer", + "example": 80 }, "watchers_count": { - "type": "integer" + "type": "integer", + "example": 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" + "type": "integer", + "example": 108 }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "example": "master" }, "open_issues_count": { - "type": "integer" + "type": "integer", + "example": 0 }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true }, "topics": { "type": "array", @@ -95459,30 +96787,51 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -95503,226 +96852,122 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, "delete_branch_on_merge": { - "type": "boolean" + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "subscribers_count": { - "type": "integer" + "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", + "example": false }, - "network_count": { - "type": "integer" + "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 }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] + "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)." }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true + "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." }, - "forks": { - "type": "integer", - "example": 0 + "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)." }, - "open_issues": { - "type": "integer", - "example": 0 + "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." }, - "watchers": { - "type": "integer", - "example": 0 + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": 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", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { "type": "boolean", - "example": false + "description": "Whether anonymous git access is enabled for this repository" }, - "security_and_analysis": { - "nullable": true, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_search_ok": { + "type": "boolean" }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_commit_sha": { + "type": "string" } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ @@ -95771,809 +97016,87 @@ "tags_url", "teams_url", "trees_url", - "url" - ] - } - } - } - }, - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/set-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "integer" - } - } - }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/add-selected-repo-to-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "No Content when repository was added to the selected list" - }, - "409": { - "description": "Conflict when visibility type is not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/remove-selected-repo-from-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response when repository was removed from the selected list" - }, - "409": { - "description": "Conflict when visibility type not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/actions/variables": { - "get": { - "summary": "List organization variables", - "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/list-org-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables" - }, - "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 30). 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": 10 - } - }, - { - "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", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "example": "USERNAME", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "example": "octocat", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a variable", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" - } - }, - "required": [ - "name", - "value", + "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", - "visibility" + "updated_at" ] } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 3, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "ACTIONS_RUNNER_DEBUG", - "value": true, - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "ADMIN_EMAIL", - "value": "octocat@github.com", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "post": { - "summary": "Create an organization variable", - "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/create-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable" - }, - "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": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - }, - "visibility": { - "type": "string", - "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", - "items": { - "type": "integer" - } - } - }, - "required": [ - "name", - "value", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a variable", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - } - }, - "/orgs/{org}/actions/variables/{name}": { - "get": { - "summary": "Get an organization variable", - "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "example": "USERNAME", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "example": "octocat", - "type": "string" }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", + "single_file": { "type": "string", - "format": "date-time" + "example": "config.yaml", + "nullable": true }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a variable", "enum": [ "all", - "private", "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" + ] } }, "required": [ - "name", - "value", - "created_at", - "updated_at", - "visibility" + "token", + "expires_at" ] }, "examples": { "default": { "value": { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "patch": { - "summary": "Update an organization variable", - "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/update-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - }, - "visibility": { - "type": "string", - "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", - "items": { - "type": "integer" + "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-22T12:13:35.123-08:00" } } } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "delete": { - "summary": "Delete an organization variable", - "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/variables/{name}/repositories": { - "get": { - "summary": "List selected repositories for an organization variable", - "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "/orgs/{org}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for an organization", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/list-selected-repos-for-org-variable", + "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" }, "parameters": [ { @@ -96584,74 +97107,133 @@ "schema": { "type": "string" } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 - } } ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } }, "repositories": { + "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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.", @@ -96777,6 +97359,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -96871,7 +97455,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string" + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", @@ -96920,7 +97505,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string" + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", @@ -96956,10 +97542,13 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string" + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -96968,10 +97557,14 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", + "format": "uri", + "example": "https://github.com", "nullable": true }, "language": { @@ -96979,26 +97572,36 @@ "nullable": true }, "forks_count": { - "type": "integer" + "type": "integer", + "example": 9 }, "stargazers_count": { - "type": "integer" + "type": "integer", + "example": 80 }, "watchers_count": { - "type": "integer" + "type": "integer", + "example": 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" + "type": "integer", + "example": 108 }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "example": "master" }, "open_issues_count": { - "type": "integer" + "type": "integer", + "example": 0 }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true }, "topics": { "type": "array", @@ -97007,30 +97610,51 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -97051,226 +97675,122 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, "delete_branch_on_merge": { - "type": "boolean" + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "subscribers_count": { - "type": "integer" + "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", + "example": false }, - "network_count": { - "type": "integer" + "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 }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] + "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)." }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true + "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." }, - "forks": { - "type": "integer", - "example": 0 + "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)." }, - "open_issues": { - "type": "integer", - "example": 0 + "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." }, - "watchers": { - "type": "integer", - "example": 0 + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": 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", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { "type": "boolean", - "example": false + "description": "Whether anonymous git access is enabled for this repository" }, - "security_and_analysis": { - "nullable": true, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_search_ok": { + "type": "boolean" }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_commit_sha": { + "type": "string" } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ @@ -97319,114 +97839,87 @@ "tags_url", "teams_url", "trees_url", - "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" ] } + }, + "single_file": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] } - } + }, + "required": [ + "token", + "expires_at" + ] }, "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] + "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-29T12:13:35.123-08:00" } } } } } - }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - }, - "put": { - "summary": "Set selected repositories for an organization variable", - "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for an organization", + "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/set-selected-repos-for-org-variable", + "operationId": "actions/get-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -97439,73 +97932,150 @@ } }, { - "name": "name", - "description": "The name of the variable.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "The IDs of the repositories that can access the organization variable.", - "items": { - "type": "integer" + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } - } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] + "examples": { + "default": { + "value": { + "id": 23, + "name": "MBP", + "os": "macos", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } } } } } } }, - "responses": { - "204": { - "description": "Response" - }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" - } - }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization variable", - "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + }, + "delete": { + "summary": "Delete a self-hosted runner from an organization", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/add-selected-repo-to-org-variable", + "operationId": "actions/delete-self-hosted-runner-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" }, "parameters": [ { @@ -97518,16 +98088,8 @@ } }, { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { @@ -97539,27 +98101,56 @@ "204": { "description": "Response" }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - }, - "delete": { - "summary": "Remove selected repository from an organization variable", - "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runners/{runner_id}/labels": { + "get": { + "summary": "List labels for a self-hosted runner for an organization", + "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/remove-selected-repo-from-org-variable", + "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -97572,16 +98163,8 @@ } }, { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { @@ -97589,216 +98172,104 @@ } } ], - "responses": { - "204": { - "description": "Response" - }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - } - }, - "/orgs/{org}/announcement": { - "get": { - "summary": "Get announcement banner for organization", - "description": "Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.", - "tags": [ - "orgs" - ], - "operationId": "announcement-banners/get-announcement-banner-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-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": "Announcement Banner", - "description": "Announcement at either the repository, organization, or enterprise level", "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "announcement": { - "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "example": "Very **important** announcement about _something_.", - "nullable": true - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "example": "\"2021-01-01T00:00:00.000-07:00\"", - "nullable": true + "total_count": { + "type": "integer" }, - "user_dismissible": { - "type": "boolean", - "description": "Whether an announcement can be dismissed by the user.", - "example": false, - "nullable": true, - "default": false + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } } - }, - "required": [ - "announcement", - "expires_at", - "user_dismissible" - ] + } }, "examples": { "default": { - "summary": "Announcement banner", "value": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } } } } } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "announcement-banners", - "subcategory": "organizations" - } - }, - "patch": { - "summary": "Set announcement banner for organization", - "description": "Sets the announcement banner to display for the organization.", - "tags": [ - "orgs" - ], - "operationId": "announcement-banners/set-announcement-banner-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#set-announcement-banner-for-organization" - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "Enterprise Announcement", - "description": "Enterprise global announcement", - "type": "object", - "properties": { - "announcement": { - "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "example": "Very **important** announcement about _something_.", - "nullable": true - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "example": "\"2021-01-01T00:00:00.000-07:00\"", - "nullable": true - }, - "user_dismissible": { - "type": "boolean", - "description": "Whether an announcement can be dismissed by the user.", - "example": false, - "nullable": true, - "default": false - } - }, - "required": [ - "announcement" - ] - }, - "examples": { - "default": { - "summary": "Announcement banner", - "value": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false - } - } - } - } - } - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Announcement Banner", - "description": "Announcement at either the repository, organization, or enterprise level", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "announcement": { - "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "example": "Very **important** announcement about _something_.", - "nullable": true + "message": { + "type": "string" }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "example": "\"2021-01-01T00:00:00.000-07:00\"", - "nullable": true + "documentation_url": { + "type": "string" }, - "user_dismissible": { - "type": "boolean", - "description": "Whether an announcement can be dismissed by the user.", - "example": false, - "nullable": true, - "default": false - } - }, - "required": [ - "announcement", - "expires_at", - "user_dismissible" - ] - }, - "examples": { - "default": { - "summary": "Announcement banner", - "value": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -97807,22 +98278,22 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "announcement-banners", - "subcategory": "organizations" + "category": "actions", + "subcategory": "self-hosted-runners" } }, - "delete": { - "summary": "Remove announcement banner from organization", - "description": "Removes the announcement banner currently set for the organization.", + "post": { + "summary": "Add custom labels to a self-hosted runner for an organization", + "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "announcement-banners/remove-announcement-banner-for-org", + "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -97833,68 +98304,14 @@ "schema": { "type": "string" } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "announcement-banners", - "subcategory": "organizations" - } - } - }, - "/orgs/{org}/attestations/bulk-list": { - "post": { - "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-attestations-bulk", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations-by-bulk-subject-digests" - }, - "parameters": [ - { - "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": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, - "schema": { - "type": "string" - } }, { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -97904,42 +98321,29 @@ "application/json": { "schema": { "type": "object", + "required": [ + "labels" + ], "properties": { - "subject_digests": { + "labels": { "type": "array", + "minItems": 1, + "maxItems": 100, + "description": "The names of the custom labels to add to the runner.", "items": { "type": "string" - }, - "description": "List of subject digests to fetch attestations for.", - "minItems": 1, - "maxItems": 1024 - }, - "predicate_type": { - "type": "string", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types." + } } - }, - "required": [ - "subject_digests" - ] + } }, "examples": { "default": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" + "labels": [ + "gpu", + "accelerated" ] } - }, - "withPredicateType": { - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ], - "predicateType": "provenance" - } } } } @@ -97952,198 +98356,69 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "attestations_subject_digests": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "array", - "items": { - "type": "object", - "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The bundle of the attestation." - }, - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - } - } - } - }, - "description": "Mapping of subject digest to bundles." + "total_count": { + "type": "integer" }, - "page_info": { - "type": "object", - "properties": { - "has_next": { - "type": "boolean", - "description": "Indicates whether there is a next page." - }, - "has_previous": { - "type": "boolean", - "description": "Indicates whether there is a previous page." - }, - "next": { - "type": "string", - "description": "The cursor to the next page." + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } }, - "previous": { - "type": "string", - "description": "The cursor to the previous page." - } - }, - "description": "Information about the current page." + "required": [ + "name" + ] + } } } }, "examples": { "default": { "value": { - "attestations_subject_digests": [ + "total_count": 4, + "labels": [ { - "sha256:abc": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" } ] } @@ -98151,27 +98426,81 @@ } } } + }, + "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 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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/attestations/delete-request": { - "post": { - "summary": "Delete attestations in bulk", - "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + }, + "put": { + "summary": "Set custom labels for a self-hosted runner for an organization", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-attestations-bulk", + "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -98182,6 +98511,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -98190,58 +98528,27 @@ "application/json": { "schema": { "type": "object", - "oneOf": [ - { - "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } - }, - "required": [ - "subject_digests" - ] - }, - { - "properties": { - "attestation_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of unique IDs associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } - }, - "required": [ - "attestation_ids" - ] - } + "required": [ + "labels" ], - "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + "properties": { + "labels": { + "type": "array", + "minItems": 0, + "maxItems": 100, + "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", + "items": { + "type": "string" + } + } + } }, "examples": { - "by-subject-digests": { - "summary": "Delete by subject digests", - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] - } - }, - "by-attestation-ids": { - "summary": "Delete by attestation IDs", + "default": { "value": { - "attestation_ids": [ - 111, - 222 + "labels": [ + "gpu", + "accelerated" ] } } @@ -98251,7 +98558,81 @@ }, "responses": { "200": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + } + } + } + } }, "404": { "description": "Resource not found", @@ -98278,64 +98659,19 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" - } - } - }, - "/orgs/{org}/attestations/digest/{subject_digest}": { - "delete": { - "summary": "Delete attestations by subject digest", - "description": "Delete an artifact attestation by subject digest.", - "tags": [ - "orgs" - ], - "operationId": "orgs/delete-attestations-by-subject-digest", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "subject_digest", - "description": "Subject Digest", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "responses": { - "200": { - "description": "Response" - }, - "204": { - "description": "Response" }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -98343,11 +98679,11 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -98358,22 +98694,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" + "category": "actions", + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/attestations/{attestation_id}": { + }, "delete": { - "summary": "Delete attestations by ID", - "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.", + "summary": "Remove all custom labels from a self-hosted runner for an organization", + "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-attestations-by-id", + "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -98386,8 +98720,8 @@ } }, { - "name": "attestation_id", - "description": "Attestation ID", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { @@ -98397,31 +98731,71 @@ ], "responses": { "200": { - "description": "Response" - }, - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + } + ] } } } @@ -98458,51 +98832,24 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" + "category": "actions", + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/attestations/{subject_digest}": { - "get": { - "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + "delete": { + "summary": "Remove a custom label from a self-hosted runner for an organization", + "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-attestations", + "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ - { - "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": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -98513,20 +98860,19 @@ } }, { - "name": "subject_digest", - "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } }, { - "name": "predicate_type", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", - "in": "query", - "required": false, + "name": "name", + "description": "The name of a self-hosted runner's custom label.", + "in": "path", + "required": true, "schema": { "type": "string" } @@ -98539,38 +98885,41 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "attestations": { + "total_count": { + "type": "integer" + }, + "labels": { "type": "array", "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", "type": "object", "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + "id": { + "type": "integer", + "description": "Unique identifier of the label." }, - "repository_id": { - "type": "integer" + "name": { + "type": "string", + "description": "Name of the label." }, - "bundle_url": { - "type": "string" + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] } - } + }, + "required": [ + "name" + ] } } } @@ -98578,128 +98927,27 @@ "examples": { "default": { "value": { - "attestations": [ + "total_count": 4, + "labels": [ { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 + "id": 5, + "name": "self-hosted", + "type": "read-only" }, { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" } ] } @@ -98707,27 +98955,83 @@ } } } + }, + "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 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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/audit-log": { + "/orgs/{org}/actions/secrets": { "get": { - "summary": "Get the audit log for an organization", - "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", - "operationId": "orgs/get-audit-log", + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], + "operationId": "actions/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets" }, "parameters": [ { @@ -98740,66 +99044,21 @@ } }, { - "name": "phrase", - "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "include", - "description": "The event types to include:\n\n- `web` - returns web (non-Git) events.\n- `git` - returns Git events.\n- `all` - returns both web and Git events.\n\nThe default is `web`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "web", - "git", - "all" - ] - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "order", - "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.", + "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", - "required": false, "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ] + "type": "integer", + "default": 30 } }, { - "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).\"", + "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": 30 + "default": 1 } } ], @@ -98809,230 +99068,119 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "@timestamp": { - "type": "integer", - "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "action": { - "type": "string", - "description": "The name of the action that was performed, for example `user.login` or `repo.create`." - }, - "active": { - "type": "boolean" - }, - "active_was": { - "type": "boolean" - }, - "actor": { - "type": "string", - "description": "The actor who performed the action." - }, - "actor_id": { - "type": "integer", - "description": "The id of the actor who performed the action." - }, - "actor_location": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { - "country_name": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" } - } - }, - "data": { - "type": "object", - "additionalProperties": true - }, - "org_id": { - "type": "integer" - }, - "user_id": { - "type": "integer" - }, - "business_id": { - "type": "integer" - }, - "blocked_user": { - "type": "string", - "description": "The username of the account being blocked." - }, - "business": { - "type": "string" - }, - "config": { - "type": "array", - "items": { - "type": "object" - } - }, - "config_was": { - "type": "array", - "items": { - "type": "object" - } - }, - "content_type": { - "type": "string" - }, - "operation_type": { - "type": "string" - }, - "created_at": { - "type": "integer", - "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "deploy_key_fingerprint": { - "type": "string" - }, - "_document_id": { - "type": "string", - "description": "A unique identifier for an audit event." - }, - "emoji": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "object" - } - }, - "events_were": { - "type": "array", - "items": { - "type": "object" - } - }, - "explanation": { - "type": "string" - }, - "fingerprint": { - "type": "string" - }, - "hook_id": { - "type": "integer" - }, - "limited_availability": { - "type": "boolean" - }, - "message": { - "type": "string" - }, - "name": { - "type": "string" - }, - "old_user": { - "type": "string" - }, - "openssh_public_key": { - "type": "string" - }, - "org": { - "type": "string" - }, - "previous_visibility": { - "type": "string" - }, - "read_only": { - "type": "boolean" - }, - "repo": { - "type": "string", - "description": "The name of the repository." - }, - "repository": { - "type": "string", - "description": "The name of the repository." - }, - "repository_public": { - "type": "boolean" - }, - "target_login": { - "type": "string" - }, - "team": { - "type": "string" - }, - "transport_protocol": { - "type": "integer", - "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "transport_protocol_name": { - "type": "string", - "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "user": { - "type": "string", - "description": "The user that was affected by the action performed (if available)." - }, - "visibility": { - "type": "string", - "description": "The repository visibility, for example `public` or `private`." + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] } } } }, "examples": { "default": { - "value": [ - { - "@timestamp": 1606929874512, - "action": "team.add_member", - "actor": "octocat", - "created_at": 1606929874512, - "_document_id": "xJJFlFOhQ6b-5vaAFy9Rjw", - "org": "octo-corp", - "team": "octo-corp/example-team", - "user": "monalisa" - }, - { - "@timestamp": 1606507117008, - "action": "org.create", - "actor": "octocat", - "created_at": 1606507117008, - "_document_id": "Vqvg6kZ4MYqwWRKFDzlMoQ", - "org": "octocat-test-org" - }, - { - "@timestamp": 1605719148837, - "action": "repo.destroy", - "actor": "monalisa", - "created_at": 1605719148837, - "_document_id": "LwW2vpJZCDS-WUmo9Z-ifw", - "org": "mona-org", - "repo": "mona-org/mona-test-repo", - "visibility": "private" - } - ] + "value": { + "total_count": 3, + "secrets": [ + { + "name": "GIST_ID", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "DEPLOY_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + } + ] + } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/blocks": { + "/orgs/{org}/actions/secrets/public-key": { "get": { - "summary": "List users blocked by an organization", - "description": "List the users blocked by an organization.", + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-blocked-users", + "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -99043,24 +99191,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": { @@ -99069,156 +99199,48 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" }, - "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" - ] - } + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] }, "examples": { "default": { - "value": [ - { - "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 - } - ] + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } } } } @@ -99228,22 +99250,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/blocks/{username}": { + "/orgs/{org}/actions/secrets/{secret_name}": { "get": { - "summary": "Check if a user is blocked by an organization", - "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/check-blocked-user", + "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret" }, "parameters": [ { @@ -99256,8 +99278,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -99266,29 +99288,58 @@ } ], "responses": { - "204": { - "description": "If the user is blocked" - }, - "404": { - "description": "If the user is not blocked", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", "type": "string" }, - "documentation_url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time" }, - "status": { + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } } } @@ -99299,20 +99350,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } }, "put": { - "summary": "Block a user from an organization", - "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/block-user", + "operationId": "actions/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -99325,8 +99376,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -99334,75 +99385,975 @@ } } ], - "responses": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "encrypted_value", + "key_id", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { "204": { "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + }, + "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": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "repositories" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "repositories": { "type": "array", "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "field": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "message": { + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "code": { + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { "type": "string" }, - "index": { + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { "type": "integer" }, - "value": { - "oneOf": [ - { + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "nullable": true + "example": "contributor_covenant" }, - { - "type": "integer", + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } } } - ] + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } + }, + "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" + ] } } } + }, + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } } } } @@ -99411,20 +100362,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } }, - "delete": { - "summary": "Unblock a user from an organization", - "description": "Unblocks the given user on behalf of the specified organization.", + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/unblock-user", + "operationId": "actions/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -99437,8 +100388,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -99446,6 +100397,37 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, "responses": { "204": { "description": "Response" @@ -99454,28 +100436,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/bypass-requests/push-rules": { - "get": { - "summary": "List push rule bypass requests within an organization", - "description": "Lists the requests made by users of a repository to bypass push protection rules within an organization.", + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-push-bypass-requests", + "operationId": "actions/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization" - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "bypass-requests" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -99488,74 +100464,122 @@ } }, { - "name": "repository_name", - "description": "The name of the repository to filter on.", - "in": "query", + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "reviewer", - "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", - "in": "query", - "required": false, + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "requester", - "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", - "in": "query", - "required": false, + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "time_period", - "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", - "in": "query", - "required": false, + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "day" + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/variables": { + "get": { + "summary": "List organization variables", + "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-org-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables" + }, + "parameters": [ { - "name": "request_status", - "description": "The status of the bypass request to filter on. When specified, only requests with this status will be returned.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "completed", - "cancelled", - "approved", - "expired", - "deleted", - "denied", - "open", - "all" - ], - "default": "all" + "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).\"", + "description": "The number of results per page (max 30). 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 + "default": 10 } }, { @@ -99574,362 +100598,345 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Push rule bypass request", - "description": "A bypass request made by a user asking to be exempted from a push rule in this repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the bypass request." - }, - "number": { - "type": "integer", - "description": "The number uniquely identifying the bypass request within its repository." - }, - "repository": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", - "description": "The repository the bypass request is for.", "properties": { - "id": { - "type": "integer", - "description": "The ID of the repository the bypass request is for.", - "nullable": true - }, "name": { - "type": "string", - "description": "The name of the repository the bypass request is for.", - "nullable": true + "description": "The name of the variable.", + "example": "USERNAME", + "type": "string" }, - "full_name": { + "value": { + "description": "The value of the variable.", + "example": "octocat", + "type": "string" + }, + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", "type": "string", - "description": "The full name of the repository the bypass request is for.", - "nullable": true - } - } - }, - "organization": { - "type": "object", - "description": "The organization associated with the repository the bypass request is for.", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the organization.", - "nullable": true + "format": "date-time" }, - "name": { + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", "type": "string", - "description": "The name of the organization.", - "nullable": true - } - } - }, - "requester": { - "type": "object", - "description": "The user who requested the bypass.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who requested the bypass." + "format": "date-time" }, - "actor_name": { + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { "type": "string", - "description": "The name of the GitHub user who requested the bypass." - } - } - }, - "request_type": { - "type": "string", - "description": "The type of request." - }, - "data": { - "nullable": true, - "type": "array", - "description": "Data describing the push rules that are being requested to be bypassed.", - "items": { - "type": "object", - "properties": { - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset for the rules that were violated." - }, - "ruleset_name": { - "type": "string", - "description": "The name of the ruleset for the rules that were violated." - }, - "total_violations": { - "type": "integer", - "description": "The number of rule violations generated from the push associated with this request." - }, - "rule_type": { - "type": "string", - "description": "The type of rule that was violated." - } + "format": "uri", + "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" } - } - }, - "resource_identifier": { - "type": "string", - "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", - "example": "827efc6d56897b048c772eb4087f854f46256132" - }, - "status": { - "type": "string", - "description": "The status of the bypass request.", - "enum": [ - "pending", - "denied", - "approved", - "cancelled", - "completed", - "expired", - "deleted", - "open" + }, + "required": [ + "name", + "value", + "created_at", + "updated_at", + "visibility" ] - }, - "requester_comment": { - "type": "string", - "description": "The comment the requester provided when creating the bypass request.", - "nullable": true - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the bypass request will expire." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the bypass request was created." - }, - "responses": { - "type": "array", - "description": "The responses to the bypass request.", - "nullable": true, - "items": { - "title": "Bypass response", - "description": "A response made by a delegated bypasser to a bypass request.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the response to the bypass request." - }, - "reviewer": { - "type": "object", - "description": "The user who reviewed the bypass request.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who reviewed the bypass request." - }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who reviewed the bypass request." - } - } - }, - "status": { - "type": "string", - "description": "The response status to the bypass request until dismissed.", - "enum": [ - "approved", - "denied", - "dismissed" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the response to the bypass request was created." - } - } - } - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1" - }, - "html_url": { - "type": "string", - "description": "The URL to view the bypass request in a browser.", - "format": "uri", - "example": "https://github.com/octo-org/smile/exemptions/1" } } } }, "examples": { "default": { - "value": [ - { - "id": 21, - "number": 42, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" - }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" - }, - "request_type": "push_ruleset_bypass", - "data": [ - { - "ruleset_id": 410, - "ruleset_name": "Exclude image files", - "total_violations": 1, - "rule_type": "file_extension_restriction" - } - ], - "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", - "status": "denied", - "requester_comment": "Updating site images to follow changes in marketing. Part 1", - "expires_at": "2024-07-08T08:43:03Z", - "created_at": "2024-07-01T08:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1", - "html_url": "https://github.com/octo-org/smile/exemptions/1" - }, - { - "id": 12, - "number": 24, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" + "value": { + "total_count": 3, + "variables": [ + { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" + { + "name": "ACTIONS_RUNNER_DEBUG", + "value": true, + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" }, - "request_type": "push_ruleset_bypass", - "data": [ - { - "ruleset_id": 410, - "ruleset_name": "Exclude image files", - "total_violations": 1, - "rule_type": "file_extension_restriction" - } - ], - "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", - "status": "denied", - "requester_comment": "Updating site images to follow changes in marketing. Part 2", - "expires_at": "2024-07-08T07:43:03Z", - "created_at": "2024-07-01T07:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2", - "html_url": "https://github.com/octo-org/smile/exemptions/2" - } + { + "name": "ADMIN_EMAIL", + "value": "octocat@github.com", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "post": { + "summary": "Create an organization variable", + "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable" + }, + "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": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + }, + "visibility": { + "type": "string", + "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "name", + "value", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 ] } } } } - }, - "404": { - "description": "Resource not found", + } + }, + "responses": { + "201": { + "description": "Response when creating a variable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}": { + "get": { + "summary": "Get an organization variable", + "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "500": { - "description": "Internal Error", + { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the variable.", + "example": "USERNAME", "type": "string" }, - "documentation_url": { + "value": { + "description": "The value of the variable.", + "example": "octocat", "type": "string" }, - "url": { - "type": "string" + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", + "type": "string", + "format": "date-time" }, - "status": { + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" } } } } } } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" } - } - }, - "/orgs/{org}/bypass-requests/secret-scanning": { - "get": { - "summary": "List bypass requests for secret scanning for an org", - "description": "List requests to bypass secret scanning push protection in an org.\n\nDelegated bypass must be enabled on repositories in the org and the user must be a bypass reviewer to access this endpoint.\nPersonal access tokens (classic) need the `security_events` scope to use this endpoint.", + }, + "patch": { + "summary": "Update an organization variable", + "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "secret-scanning" + "actions" ], - "operationId": "secret-scanning/list-org-bypass-requests", + "operationId": "actions/update-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org" - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "secret-scanning", - "subcategory": "delegated-bypass" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable" }, "parameters": [ { @@ -99942,83 +100949,167 @@ } }, { - "name": "repository_name", - "description": "The name of the repository to filter on.", - "in": "query", + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { "type": "string" } - }, + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + }, + "visibility": { + "type": "string", + "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Delete an organization variable", + "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable" + }, + "parameters": [ { - "name": "reviewer", - "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "requester", - "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", - "in": "query", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { "type": "string" } - }, + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}/repositories": { + "get": { + "summary": "List selected repositories for an organization variable", + "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable" + }, + "parameters": [ { - "name": "time_period", - "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "day" + "type": "string" } }, { - "name": "request_status", - "description": "The status of the bypass request to filter on. When specified, only requests with this status will be returned.", - "in": "query", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "completed", - "cancelled", - "approved", - "expired", - "deleted", - "denied", - "open", - "all" - ], - "default": "all" + "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).\"", + "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": 30 + "default": 1 } }, { - "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).\"", + "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": 1 + "default": 30 } } ], @@ -100028,355 +101119,893 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Secret scanning bypass request", - "description": "A bypass request made by a user asking to be exempted from push protection in this repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the bypass request." - }, - "number": { - "type": "integer", - "description": "The number uniquely identifying the bypass request within its repository." - }, - "repository": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "description": "The repository the bypass request is for.", "properties": { "id": { "type": "integer", - "description": "The ID of the repository the bypass request is for." - }, - "name": { - "type": "string", - "description": "The name of the repository the bypass request is for." + "format": "int64", + "example": 1296269 }, - "full_name": { + "node_id": { "type": "string", - "description": "The full name of the repository the bypass request is for." - } - } - }, - "organization": { - "type": "object", - "description": "The organization associated with the repository the bypass request is for.", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the organization." + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", - "description": "The name of the organization." - } - } - }, - "requester": { - "type": "object", - "description": "The user who requested the bypass.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who requested the bypass." + "example": "Hello-World" }, - "actor_name": { + "full_name": { "type": "string", - "description": "The name of the GitHub user who requested the bypass." - } - } - }, - "request_type": { - "type": "string", - "description": "The type of request." - }, - "data": { - "nullable": true, - "type": "array", - "description": "Data describing the push rules that are being requested to be bypassed.", - "items": { - "type": "object", - "properties": { - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "bypass_reason": { - "type": "string", - "enum": [ - "used_in_tests", - "false_positive", - "fix_later" - ], - "description": "The reason the bypass was requested." - }, - "path": { - "type": "string", - "description": "The path in the repo where the secret was located during the request." - }, - "branch": { - "type": "string", - "description": "The branch in the repo where the secret was located during the request." - } - } - } - }, - "resource_identifier": { - "type": "string", - "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", - "example": "827efc6d56897b048c772eb4087f854f46256132" - }, - "status": { - "type": "string", - "description": "The status of the bypass request.", - "enum": [ - "pending", - "denied", - "approved", - "cancelled", - "completed", - "expired", - "open" - ] - }, - "requester_comment": { - "type": "string", - "description": "The comment the requester provided when creating the bypass request.", - "nullable": true - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the bypass request will expire." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the bypass request was created." - }, - "responses": { - "type": "array", - "description": "The responses to the bypass request.", - "nullable": true, - "items": { - "title": "Bypass response", - "description": "A response made by a delegated bypasser to a bypass request.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the response to the bypass request." + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "reviewer": { - "type": "object", - "description": "The user who reviewed the bypass request.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who reviewed the bypass request." - }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who reviewed the bypass request." - } + "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true } }, - "status": { - "type": "string", - "description": "The response status to the bypass request until dismissed.", - "enum": [ - "approved", - "denied", - "dismissed" - ] + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the response to the bypass request was created." + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1" - }, - "html_url": { - "type": "string", - "description": "The URL to view the bypass request in a browser.", - "format": "uri", - "example": "https://github.com/octo-org/smile/exemptions/1" + }, + "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" + ] } } } }, "examples": { "default": { - "value": [ - { - "id": 21, - "number": 42, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" - }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" - }, - "request_type": "secret_scanning", - "data": [ - { - "secret_type": "adafruit_io_key", - "bypass_reason": "used_in_tests", - "path": "/tests/README.md:16:0", - "branch": "refs/heads/main" - } - ], - "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", - "status": "denied", - "requester_comment": "Test token used in the readme as an example", - "expires_at": "2024-07-08T08:43:03Z", - "created_at": "2024-07-01T08:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1", - "html_url": "https://github.com/octo-org/smile/exemptions/1" - }, - { - "id": 12, - "number": 24, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" - }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" - }, - "request_type": "secret_scanning", - "data": [ - { - "secret_type": "adafruit_io_key", - "bypass_reason": "fix_later", - "path": "README.md:17:0", - "branch": "refs/heads/my-branch" - } - ], - "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", - "status": "denied", - "requester_comment": "Token is already revoked, I'll remove it later", - "expires_at": "2024-07-08T07:43:03Z", - "created_at": "2024-07-01T07:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/2", - "html_url": "https://github.com/octo-org/smile/exemptions/2" - } - ] + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } } } } } }, - "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": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "put": { + "summary": "Set selected repositories for an organization variable", + "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/set-selected-repos-for-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "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" + { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "The IDs of the repositories that can access the organization variable.", + "items": { + "type": "integer" } } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } } } } } + }, + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" } } }, - "/orgs/{org}/campaigns": { - "get": { - "summary": "List campaigns for an organization", - "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization variable", + "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "campaigns" + "actions" ], - "operationId": "campaigns/list-org-campaigns", + "operationId": "actions/add-selected-repo-to-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable" }, "parameters": [ { @@ -100389,66 +102018,113 @@ } }, { - "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", + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "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", + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response" }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Remove selected repository from an organization variable", + "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable" + }, + "parameters": [ { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" + "type": "string" } }, { - "name": "state", - "description": "If specified, only campaigns with this state will be returned.", - "in": "query", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] + "type": "string" } }, { - "name": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "ends_at", - "published" - ], - "default": "created" + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/announcement": { + "get": { + "summary": "Get announcement banner for organization", + "description": "Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.", + "tags": [ + "orgs" + ], + "operationId": "announcement-banners/get-announcement-banner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], @@ -100458,527 +102134,171 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] - } + "title": "Announcement Banner", + "description": "Announcement at either the repository, organization, or enterprise level", + "type": "object", + "properties": { + "announcement": { + "type": "string", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "example": "Very **important** announcement about _something_.", + "nullable": true }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] - } + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", + "example": "\"2021-01-01T00:00:00.000-07:00\"", + "nullable": true + }, + "user_dismissible": { + "type": "boolean", + "description": "Whether an announcement can be dismissed by the user.", + "example": false, + "nullable": true, + "default": false + } + }, + "required": [ + "announcement", + "expires_at", + "user_dismissible" + ] }, "examples": { "default": { - "value": [ - { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - { - "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 - } - ], - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open" - }, - { - "number": 4, - "created_at": "2024-03-30T12:29:18Z", - "updated_at": "2024-03-30T12:29:18Z", - "name": "Mitre top 10 KEV", - "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.", - "managers": [ - { - "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 - } - ], - "ends_at": "2024-04-30T12:29:18Z", - "closed_at": null, - "state": "open" - } - ] + "summary": "Announcement banner", + "value": { + "announcement": "Very **important** announcement about _something_.", + "expires_at": "2021-01-01T00:00:00.000+00:00", + "user_dismissible": false + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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": true, + "enabledForGitHubApps": true, + "category": "announcement-banners", + "subcategory": "organizations" + } + }, + "patch": { + "summary": "Set announcement banner for organization", + "description": "Sets the announcement banner to display for the organization.", + "tags": [ + "orgs" + ], + "operationId": "announcement-banners/set-announcement-banner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#set-announcement-banner-for-organization" + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Enterprise Announcement", + "description": "Enterprise global announcement", + "type": "object", + "properties": { + "announcement": { + "type": "string", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "example": "Very **important** announcement about _something_.", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", + "example": "\"2021-01-01T00:00:00.000-07:00\"", + "nullable": true + }, + "user_dismissible": { + "type": "boolean", + "description": "Whether an announcement can be dismissed by the user.", + "example": false, + "nullable": true, + "default": false + } + }, + "required": [ + "announcement" + ] + }, + "examples": { + "default": { + "summary": "Announcement banner", + "value": { + "announcement": "Very **important** announcement about _something_.", + "expires_at": "2021-01-01T00:00:00.000+00:00", + "user_dismissible": false } } } } - }, - "503": { - "description": "Service unavailable", + } + }, + "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": "Announcement Banner", + "description": "Announcement at either the repository, organization, or enterprise level", "type": "object", "properties": { - "code": { - "type": "string" + "announcement": { + "type": "string", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "example": "Very **important** announcement about _something_.", + "nullable": true }, - "message": { - "type": "string" + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", + "example": "\"2021-01-01T00:00:00.000-07:00\"", + "nullable": true }, - "documentation_url": { - "type": "string" + "user_dismissible": { + "type": "boolean", + "description": "Whether an announcement can be dismissed by the user.", + "example": false, + "nullable": true, + "default": false + } + }, + "required": [ + "announcement", + "expires_at", + "user_dismissible" + ] + }, + "examples": { + "default": { + "summary": "Announcement banner", + "value": { + "announcement": "Very **important** announcement about _something_.", + "expires_at": "2021-01-01T00:00:00.000+00:00", + "user_dismissible": false } } } @@ -100987,24 +102307,87 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "announcement-banners", + "subcategory": "organizations" } }, + "delete": { + "summary": "Remove announcement banner from organization", + "description": "Removes the announcement banner currently set for the organization.", + "tags": [ + "orgs" + ], + "operationId": "announcement-banners/remove-announcement-banner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-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" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "announcement-banners", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/attestations/bulk-list": { "post": { - "summary": "Create a campaign for an organization", - "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.", + "summary": "List attestations by bulk subject digests", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ - "campaigns" + "orgs" ], - "operationId": "campaigns/create-campaign", + "operationId": "orgs/list-attestations-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations-by-bulk-subject-digests" }, "parameters": [ + { + "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": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -101021,108 +102404,42 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": false, "properties": { - "name": { - "description": "The name of the campaign", - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "description": { - "description": "A description for the campaign", - "type": "string", - "minLength": 1, - "maxLength": 255 - }, - "managers": { - "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", - "type": "array", - "maxItems": 10, - "items": { - "description": "The login of each manager", - "type": "string" - } - }, - "team_managers": { - "description": "The slugs of the teams to set as the campaign managers.", + "subject_digests": { "type": "array", - "maxItems": 10, "items": { - "description": "The slug of each team", "type": "string" - } - }, - "ends_at": { - "description": "The end date and time of the campaign. The date must be in the future.", - "type": "string", - "format": "date-time" - }, - "contact_link": { - "description": "The contact link of the campaign. Must be a URI.", - "type": "string", - "format": "uri", - "nullable": true - }, - "code_scanning_alerts": { - "description": "The code scanning alerts to include in this campaign", - "type": "array", + }, + "description": "List of subject digests to fetch attestations for.", "minItems": 1, - "items": { - "type": "object", - "additionalProperties": false, - "properties": { - "repository_id": { - "type": "integer", - "description": "The repository id" - }, - "alert_numbers": { - "type": "array", - "description": "The alert numbers", - "minItems": 1, - "items": { - "type": "integer" - } - } - }, - "required": [ - "repository_id", - "alert_numbers" - ] - } + "maxItems": 1024 }, - "generate_issues": { - "description": "If true, will automatically generate issues for the campaign. The default is false.", - "type": "boolean", - "default": false + "predicate_type": { + "type": "string", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types." } }, "required": [ - "name", - "description", - "ends_at", - "code_scanning_alerts" + "subject_digests" ] }, "examples": { "default": { "value": { - "name": "Critical CodeQL alerts", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - "octocat" - ], - "ends_at": "2024-03-14T00:00:00Z", - "code_scanning_alerts": [ - { - "repository_id": 1296269, - "alert_numbers": [ - 1, - 2 - ] - } + "subject_digests": [ + "sha256:abc123", + "sha512:def456" ] } + }, + "withPredicateType": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ], + "predicateType": "provenance" + } } } } @@ -101134,543 +102451,201 @@ "content": { "application/json": { "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", "type": "object", "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The bundle of the attestation." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + }, + "description": "Mapping of subject digest to bundles." }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { + "page_info": { "type": "object", - "additionalProperties": false, "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" + "has_next": { + "type": "boolean", + "description": "Indicates whether there is a next page." }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" + "has_previous": { + "type": "boolean", + "description": "Indicates whether there is a previous page." }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" + "next": { + "type": "string", + "description": "The cursor to the next page." + }, + "previous": { + "type": "string", + "description": "The cursor to the previous page." } }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] + "description": "Information about the current page." } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] + } }, "examples": { "default": { "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ + "attestations_subject_digests": [ { - "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 + "sha256:abc": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "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": "Unprocessable Entity", - "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" - } - } - } - } - } - }, - "429": { - "description": "Too Many Requests" - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + ] } } } @@ -101681,22 +102656,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "orgs", + "subcategory": "orgs" } } }, - "/orgs/{org}/campaigns/{campaign_number}": { - "get": { - "summary": "Get a campaign for an organization", - "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "/orgs/{org}/attestations/delete-request": { + "post": { + "summary": "Delete attestations in bulk", + "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", "tags": [ - "campaigns" + "orgs" ], - "operationId": "campaigns/get-campaign-summary", + "operationId": "orgs/delete-attestations-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk" }, "parameters": [ { @@ -101707,463 +102682,76 @@ "schema": { "type": "string" } - }, - { - "name": "campaign_number", - "description": "The campaign number.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "oneOf": [ + { + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" }, - "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" - ] + "description": "List of subject digests associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 } }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } + "required": [ + "subject_digests" + ] + }, + { + "properties": { + "attestation_ids": { + "type": "array", + "items": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] + "description": "List of unique IDs associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 } }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] - } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] + "required": [ + "attestation_ids" + ] + } + ], + "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + }, + "examples": { + "by-subject-digests": { + "summary": "Delete by subject digests", + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } }, - "examples": { - "default": { - "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - { - "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 - } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } - } + "by-attestation-ids": { + "summary": "Delete by attestation IDs", + "value": { + "attestation_ids": [ + 111, + 222 + ] } } } } + } + }, + "responses": { + "200": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -102190,72 +102778,27 @@ } } } - }, - "422": { - "description": "Unprocessable Entity", - "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": "campaigns", - "subcategory": "campaigns" + "category": "orgs", + "subcategory": "attestations" } - }, - "patch": { - "summary": "Update a campaign", - "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + } + }, + "/orgs/{org}/attestations/digest/{subject_digest}": { + "delete": { + "summary": "Delete attestations by subject digest", + "description": "Delete an artifact attestation by subject digest.", "tags": [ - "campaigns" + "orgs" ], - "operationId": "campaigns/update-campaign", + "operationId": "orgs/delete-attestations-by-subject-digest", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest" }, "parameters": [ { @@ -102268,556 +102811,22 @@ } }, { - "name": "campaign_number", - "description": "The campaign number.", + "name": "subject_digest", + "description": "Subject Digest", "in": "path", "required": true, "schema": { - "type": "integer" - } + "type": "string" + }, + "x-multi-segment": true } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "description": "The name of the campaign", - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "description": { - "description": "A description for the campaign", - "type": "string", - "minLength": 1, - "maxLength": 255 - }, - "managers": { - "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - } - }, - "team_managers": { - "description": "The slugs of the teams to set as the campaign managers.", - "type": "array", - "maxItems": 10, - "items": { - "description": "The slug of each team", - "type": "string" - } - }, - "ends_at": { - "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "contact_link": { - "description": "The contact link of the campaign. Must be a URI.", - "type": "string", - "format": "uri", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - } - } - }, - "examples": { - "default": { - "value": { - "name": "Critical CodeQL alerts" - } - } - } - } - } - }, "responses": { "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] - } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] - }, - "examples": { - "default": { - "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - { - "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 - } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } - } - } - } - } - } + "description": "Response" }, - "400": { - "description": "Bad Request", - "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" - } - } - } - } - } + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -102844,72 +102853,27 @@ } } } - }, - "422": { - "description": "Unprocessable Entity", - "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": "campaigns", - "subcategory": "campaigns" + "category": "orgs", + "subcategory": "attestations" } - }, + } + }, + "/orgs/{org}/attestations/{attestation_id}": { "delete": { - "summary": "Delete a campaign for an organization", - "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "summary": "Delete attestations by ID", + "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.", "tags": [ - "campaigns" + "orgs" ], - "operationId": "campaigns/delete-campaign", + "operationId": "orgs/delete-attestations-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id" }, "parameters": [ { @@ -102922,8 +102886,8 @@ } }, { - "name": "campaign_number", - "description": "The campaign number.", + "name": "attestation_id", + "description": "Attestation ID", "in": "path", "required": true, "schema": { @@ -102932,11 +102896,14 @@ } ], "responses": { + "200": { + "description": "Response" + }, "204": { - "description": "Deletion successful" + "description": "Response" }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -102961,21 +102928,26 @@ } } }, - "503": { - "description": "Service unavailable", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "code": { - "type": "string" - }, "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -102986,52 +102958,31 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "orgs", + "subcategory": "attestations" } } }, - "/orgs/{org}/code-scanning/alerts": { + "/orgs/{org}/attestations/{subject_digest}": { "get": { - "summary": "List code scanning alerts for an organization", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ - "code-scanning" + "orgs" ], - "operationId": "code-scanning/list-alerts-for-org", + "operationId": "orgs/list-attestations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - } - }, - { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "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", - "required": false, "schema": { - "nullable": true, - "type": "string", - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + "type": "integer", + "default": 30 } }, { @@ -103053,84 +103004,31 @@ } }, { - "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 - } - }, - { - "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": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "state", - "description": "If specified, only code scanning alerts with this state will be returned.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" - ] + "type": "string" } }, { - "name": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } + "type": "string" + }, + "x-multi-segment": true }, { - "name": "severity", - "description": "If specified, only code scanning alerts with this severity will be returned.", + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", "in": "query", "required": false, "schema": { - "type": "string", - "description": "Severity of a code scanning alert.", - "enum": [ - "critical", - "high", - "medium", - "low", - "warning", - "note", - "error" - ] + "type": "string" } } ], @@ -103140,1239 +103038,170 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "nullable": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "fixed_at": { - "type": "string", - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "dismissed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "dismissed_at": { - "type": "string", - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "dismissed_reason": { - "type": "string", - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests" - ] - }, - "dismissed_comment": { - "type": "string", - "description": "The dismissal comment associated with the dismissal of the alert.", - "nullable": true, - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "nullable": true, - "type": "string", - "description": "A unique identifier for the rule used to detect the alert." - }, - "name": { - "type": "string", - "description": "The name of the rule used to detect the alert." - }, - "severity": { - "nullable": true, - "type": "string", - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error" - ] - }, - "security_severity_level": { - "nullable": true, - "type": "string", - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - }, - "full_description": { - "type": "string", - "description": "A description of the rule used to detect the alert." - }, - "tags": { - "nullable": true, - "type": "array", - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, - "help": { - "nullable": true, - "type": "string", - "description": "Detailed documentation for the rule as GitHub Flavored Markdown." - }, - "help_uri": { - "nullable": true, - "type": "string", - "description": "A link to the documentation for the rule used to detect the alert." - } - } - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "nullable": true, - "type": "string", - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "nullable": true, - "type": "string", - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - } - }, - "most_recent_instance": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "analysis_key": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." - }, - "environment": { - "type": "string", - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "nullable": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "commit_sha": { - "type": "string" - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "location": { - "type": "object", - "description": "Describe a region within a file for the alert.", - "properties": { - "path": { - "type": "string" - }, - "start_line": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "start_column": { - "type": "integer" - }, - "end_column": { - "type": "integer" - } - } - }, - "html_url": { - "type": "string" - }, - "classifications": { - "type": "array", - "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", - "items": { - "type": "string", - "description": "A classification of the file. For example to identify it as generated.", - "nullable": true, - "enum": [ - "source", - "generated", - "test", - "library" - ] - } - } - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "bundle": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, + "mediaType": { "type": "string" }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true }, - "user_view_type": { - "type": "string", - "example": "public" + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true } }, - "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", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "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" - ] - }, - "dismissal_approved_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" + "repository_id": { + "type": "integer" }, - "email": { - "nullable": true, + "bundle_url": { "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true + } } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance", - "repository" - ] + } } }, "examples": { "default": { - "value": [ - { - "number": 4, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", - "html_url": "https://github.com/octocat/hello-world/code-scanning/4", - "state": "open", - "dismissed_by": null, - "dismissed_at": null, - "dismissed_reason": null, - "dismissed_comment": null, - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", - "repository": { - "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}", - "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}", - "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}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" - } - }, - { - "number": 3, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", - "html_url": "https://github.com/octocat/hello-world/code-scanning/3", - "state": "dismissed", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "lib/ab12-gen.js", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } }, - "classifications": [] + "repository_id": 1 }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", - "repository": { - "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 + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } }, - "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}", - "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}", - "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}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + "repository_id": 1 } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + ] } } } @@ -104383,22 +103212,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-scanning", - "subcategory": "code-scanning" + "category": "orgs", + "subcategory": "orgs" } } }, - "/orgs/{org}/code-security/configurations": { + "/orgs/{org}/audit-log": { "get": { - "summary": "Get code security configurations for an organization", - "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "Get the audit log for an organization", + "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "operationId": "orgs/get-audit-log", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/get-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization" }, "parameters": [ { @@ -104411,32 +103240,40 @@ } }, { - "name": "target_type", + "name": "phrase", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "include", + "description": "The event types to include:\n\n- `web` - returns web (non-Git) events.\n- `git` - returns Git events.\n- `all` - returns both web and Git events.\n\nThe default is `web`.", "in": "query", - "description": "The target type of the code security configuration", "required": false, "schema": { "type": "string", "enum": [ - "global", + "web", + "git", "all" - ], - "default": "all" + ] } }, { - "name": "per_page", + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", "in": "query", - "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).\"", "required": false, "schema": { - "type": "integer", - "default": 30 + "type": "string" } }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", "in": "query", "required": false, "schema": { @@ -104444,12 +103281,25 @@ } }, { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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).\"", + "name": "order", + "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.", "in": "query", "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "desc", + "asc" + ] + } + }, + { + "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 } } ], @@ -104462,371 +103312,465 @@ "type": "array", "items": { "type": "object", - "description": "A code security configuration", "properties": { - "id": { + "@timestamp": { "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." }, - "target_type": { + "action": { "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." }, - "description": { - "type": "string", - "description": "A description of the code security configuration" + "active": { + "type": "boolean" }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] + "active_was": { + "type": "boolean" }, - "dependency_graph": { + "actor": { "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The actor who performed the action." }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "actor_id": { + "type": "integer", + "description": "The id of the actor who performed the action." }, - "dependency_graph_autosubmit_action_options": { + "actor_location": { "type": "object", - "description": "Feature options for Automatic dependency submission", "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + "country_name": { + "type": "string" } } }, - "dependabot_alerts": { + "data": { + "type": "object", + "additionalProperties": true + }, + "org_id": { + "type": "integer" + }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, + "blocked_user": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The username of the account being blocked." }, - "dependabot_security_updates": { + "business": { + "type": "string" + }, + "config": { + "type": "array", + "items": { + "type": "object" + } + }, + "config_was": { + "type": "array", + "items": { + "type": "object" + } + }, + "content_type": { + "type": "string" + }, + "operation_type": { + "type": "string" + }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { + "type": "string" + }, + "_document_id": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "A unique identifier for an audit event." }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } + "emoji": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "object" } }, - "code_scanning_default_setup": { + "events_were": { + "type": "array", + "items": { + "type": "object" + } + }, + "explanation": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "hook_id": { + "type": "integer" + }, + "limited_availability": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "old_user": { + "type": "string" + }, + "openssh_public_key": { + "type": "string" + }, + "org": { + "type": "string" + }, + "previous_visibility": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "repo": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The name of the repository." }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", + "repository": { + "type": "string", + "description": "The name of the repository." + }, + "repository_public": { + "type": "boolean" + }, + "target_login": { + "type": "string" + }, + "team": { + "type": "string" + }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { + "type": "string", + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "user": { + "type": "string", + "description": "The user that was affected by the action performed (if available)." + }, + "visibility": { + "type": "string", + "description": "The repository visibility, for example `public` or `private`." + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "@timestamp": 1606929874512, + "action": "team.add_member", + "actor": "octocat", + "created_at": 1606929874512, + "_document_id": "xJJFlFOhQ6b-5vaAFy9Rjw", + "org": "octo-corp", + "team": "octo-corp/example-team", + "user": "monalisa" + }, + { + "@timestamp": 1606507117008, + "action": "org.create", + "actor": "octocat", + "created_at": 1606507117008, + "_document_id": "Vqvg6kZ4MYqwWRKFDzlMoQ", + "org": "octocat-test-org" + }, + { + "@timestamp": 1605719148837, + "action": "repo.destroy", + "actor": "monalisa", + "created_at": 1605719148837, + "_document_id": "LwW2vpJZCDS-WUmo9Z-ifw", + "org": "mona-org", + "repo": "mona-org/mona-test-repo", + "visibility": "private" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/blocks": { + "get": { + "summary": "List users blocked by an organization", + "description": "List the users blocked by an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-blocked-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-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": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } + "type": "string" }, - "code_scanning_delegated_alert_dismissal": { + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "octocat" }, - "secret_scanning": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "MDQ6VXNlcjE=" }, - "secret_scanning_push_protection": { + "avatar_url": { "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "secret_scanning_delegated_bypass": { + "gravatar_id": { "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "secret_scanning_validity_checks": { + "html_url": { "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://github.com/octocat" }, - "secret_scanning_non_provider_patterns": { + "followers_url": { "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "secret_scanning_generic_secrets": { + "following_url": { "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "secret_scanning_delegated_alert_dismissal": { + "gists_url": { "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "private_vulnerability_reporting": { + "starred_url": { "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "enforcement": { + "subscriptions_url": { "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "url": { + "organizations_url": { "type": "string", "format": "uri", - "description": "The URL of the configuration" + "example": "https://api.github.com/users/octocat/orgs" }, - "html_url": { + "repos_url": { "type": "string", "format": "uri", - "description": "The URL of the configuration" + "example": "https://api.github.com/users/octocat/repos" }, - "created_at": { + "events_url": { "type": "string", - "format": "date-time" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "updated_at": { + "received_events_url": { "type": "string", - "format": "date-time" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] } }, "examples": { "default": { "value": [ { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_delagated_alert_dismissal": "enabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "enabled", - "secret_scanning_delegated_bypass_options": { - "reviewers": [ - { - "security_configuration_id": 17, - "reviewer_id": 5678, - "reviewer_type": "TEAM" - } - ] - }, - "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "secret_scanning_delegated_alert_dismissal": "not_set", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - }, - { - "id": 1326, - "target_type": "organization", - "name": "High risk settings", - "description": "This is a code security configuration for octo-org high risk repositories", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "enabled", - "code_scanning_default_setup": "enabled", - "code_scanning_delagated_alert_dismissal": "enabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", - "created_at": "2024-05-10T00:00:00Z", - "updated_at": "2024-05-10T00:00:00Z" + "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 } ] } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + } + }, + "/orgs/{org}/blocks/{username}": { + "get": { + "summary": "Check if a user is blocked by an organization", + "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-blocked-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "If the user is blocked" + }, + "404": { + "description": "If the user is not blocked", "content": { "application/json": { "schema": { @@ -104855,20 +103799,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" } }, - "post": { - "summary": "Create a code security configuration", - "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "put": { + "summary": "Block a user from an organization", + "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/create-configuration", + "operationId": "orgs/block-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization" }, "parameters": [ { @@ -104879,605 +103823,84 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ], - "default": "disabled" - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "enabled" - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", - "default": false - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "code_scanning_options": { - "type": "object", - "description": "Security Configuration feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "not_set" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ], - "default": "enforced" - } - }, - "required": [ - "name", - "description" - ] - }, - "examples": { - "default": { - "summary": "Example for a code security configuration", - "value": { - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "secret_scanning": "enabled" - } - } - } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { - "201": { - "description": "Successfully created code security configuration", + "204": { + "description": "Response" + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error", + "description": "Validation Error", "type": "object", - "description": "A code security configuration", + "required": [ + "message", + "documentation_url" + ], "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "message": { + "type": "string" }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "documentation_url": { + "type": "string" }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { + "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", + "nullable": true + }, + { "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "nullable": true }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } } - } + ] } } } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" } } } @@ -105488,22 +103911,71 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" + } + }, + "delete": { + "summary": "Unblock a user from an organization", + "description": "Unblocks the given user on behalf of the specified organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/unblock-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" } } }, - "/orgs/{org}/code-security/configurations/defaults": { + "/orgs/{org}/bypass-requests/push-rules": { "get": { - "summary": "Get default code security configurations", - "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "List push rule bypass requests within an organization", + "description": "Lists the requests made by users of a repository to bypass push protection rules within an organization.", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/get-default-configurations", + "operationId": "orgs/list-push-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "bypass-requests" }, "parameters": [ { @@ -105514,6 +103986,86 @@ "schema": { "type": "string" } + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + { + "name": "request_status", + "description": "The status of the bypass request to filter on. When specified, only requests with this status will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "deleted", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "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": { @@ -105523,281 +104075,188 @@ "application/json": { "schema": { "type": "array", - "description": "A list of default code security configurations", "items": { + "title": "Push rule bypass request", + "description": "A bypass request made by a user asking to be exempted from a push rule in this repository.", "type": "object", "properties": { - "default_for_new_repos": { - "enum": [ - "public", - "private_and_internal", - "all" - ], - "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + "id": { + "type": "integer", + "description": "The unique identifier of the bypass request." }, - "configuration": { + "number": { + "type": "integer", + "description": "The number uniquely identifying the bypass request within its repository." + }, + "repository": { "type": "object", - "description": "A code security configuration", + "description": "The repository the bypass request is for.", "properties": { "id": { "type": "integer", - "description": "The ID of the code security configuration" + "description": "The ID of the repository the bypass request is for.", + "nullable": true }, "name": { "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } + "description": "The name of the repository the bypass request is for.", + "nullable": true }, - "dependabot_alerts": { + "full_name": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The full name of the repository the bypass request is for.", + "nullable": true + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization.", + "nullable": true }, - "dependabot_security_updates": { + "name": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } + "description": "The name of the organization.", + "nullable": true + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the bypass.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the bypass." }, - "code_scanning_default_setup": { + "actor_name": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } + "description": "The name of the GitHub user who requested the bypass." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "nullable": true, + "type": "array", + "description": "Data describing the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated." + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated." + }, + "total_violations": { + "type": "integer", + "description": "The number of rule violations generated from the push associated with this request." + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated." } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "status": { + "type": "string", + "description": "The status of the bypass request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "completed", + "expired", + "deleted", + "open" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the bypass request.", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the bypass request.", + "nullable": true, + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." } } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" } } + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1" + }, + "html_url": { + "type": "string", + "description": "The URL to view the bypass request in a browser.", + "format": "uri", + "example": "https://github.com/octo-org/smile/exemptions/1" } } } @@ -105806,84 +104265,92 @@ "default": { "value": [ { - "default_for_new_repos": "public", - "configuration": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "enabled", - "secret_scanning_delegated_bypass_options": { - "reviewers": [ - { - "security_configuration_id": 1325, - "reviewer_id": 5678, - "reviewer_type": "TEAM" - } - ] - }, - "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "push_ruleset_bypass", + "data": [ + { + "ruleset_id": 410, + "ruleset_name": "Exclude image files", + "total_violations": 1, + "rule_type": "file_extension_restriction" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", + "status": "denied", + "requester_comment": "Updating site images to follow changes in marketing. Part 1", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1", + "html_url": "https://github.com/octo-org/smile/exemptions/1" }, { - "default_for_new_repos": "private_and_internal", - "configuration": { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - } + "id": 12, + "number": 24, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "push_ruleset_bypass", + "data": [ + { + "ruleset_id": 410, + "ruleset_name": "Exclude image files", + "total_violations": 1, + "rule_type": "file_extension_restriction" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", + "status": "denied", + "requester_comment": "Updating site images to follow changes in marketing. Part 2", + "expires_at": "2024-07-08T07:43:03Z", + "created_at": "2024-07-01T07:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2", + "html_url": "https://github.com/octo-org/smile/exemptions/2" } ] } @@ -105891,11 +104358,8 @@ } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -105920,8 +104384,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -105946,26 +104410,26 @@ } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" } } }, - "/orgs/{org}/code-security/configurations/detach": { - "delete": { - "summary": "Detach configurations from repositories", - "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "/orgs/{org}/bypass-requests/secret-scanning": { + "get": { + "summary": "List bypass requests for secret scanning for an org", + "description": "List requests to bypass secret scanning push protection in an org.\n\nDelegated bypass must be enabled on repositories in the org and the user must be a bypass reviewer to access this endpoint.\nPersonal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "secret-scanning" ], - "operationId": "code-security/detach-configuration", + "operationId": "secret-scanning/list-org-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "delegated-bypass" }, "parameters": [ { @@ -105976,127 +104440,372 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", - "minItems": 1, - "maxItems": 1000, - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } - } - } - }, - "examples": { - "default": { - "summary": "Example for detaching repositories from configurations.", - "value": { - "selected_repository_ids": [ - 32, - 91 - ] - } - } - } + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + { + "name": "request_status", + "description": "The status of the bypass request to filter on. When specified, only requests with this status will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "deleted", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "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": { - "204": { - "description": "A header with no content is returned." - }, - "400": { - "description": "Bad Request", + "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" + "type": "array", + "items": { + "title": "Secret scanning bypass request", + "description": "A bypass request made by a user asking to be exempted from push protection in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the bypass request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the bypass request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the bypass request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the bypass request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the bypass request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the bypass.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the bypass." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the bypass." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "nullable": true, + "type": "array", + "description": "Data describing the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "bypass_reason": { + "type": "string", + "enum": [ + "used_in_tests", + "false_positive", + "fix_later" + ], + "description": "The reason the bypass was requested." + }, + "path": { + "type": "string", + "description": "The path in the repo where the secret was located during the request." + }, + "branch": { + "type": "string", + "description": "The branch in the repo where the secret was located during the request." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "status": { + "type": "string", + "description": "The status of the bypass request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "completed", + "expired", + "open" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the bypass request.", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the bypass request.", + "nullable": true, + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1" + }, + "html_url": { + "type": "string", + "description": "The URL to view the bypass request in a browser.", + "format": "uri", + "example": "https://github.com/octo-org/smile/exemptions/1" } } } - } - } - } - }, - "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": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning", + "data": [ + { + "secret_type": "adafruit_io_key", + "bypass_reason": "used_in_tests", + "path": "/tests/README.md:16:0", + "branch": "refs/heads/main" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1", + "html_url": "https://github.com/octo-org/smile/exemptions/1" + }, + { + "id": 12, + "number": 24, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning", + "data": [ + { + "secret_type": "adafruit_io_key", + "bypass_reason": "fix_later", + "path": "README.md:17:0", + "branch": "refs/heads/my-branch" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", + "status": "denied", + "requester_comment": "Token is already revoked, I'll remove it later", + "expires_at": "2024-07-08T07:43:03Z", + "created_at": "2024-07-01T07:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/2", + "html_url": "https://github.com/octo-org/smile/exemptions/2" + } + ] } } } @@ -106128,8 +104837,8 @@ } } }, - "409": { - "description": "Conflict", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -106154,26 +104863,20 @@ } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" } } }, - "/orgs/{org}/code-security/configurations/{configuration_id}": { + "/orgs/{org}/campaigns": { "get": { - "summary": "Get a code security configuration", - "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "summary": "List campaigns for an organization", + "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/get-configuration", + "operationId": "campaigns/list-org-campaigns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization" }, "parameters": [ { @@ -106186,12 +104889,66 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, + "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" + "type": "integer", + "default": 1 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "state", + "description": "If specified, only campaigns with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "ends_at", + "published" + ], + "default": "created" } } ], @@ -106201,317 +104958,488 @@ "content": { "application/json": { "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + "type": "array", + "items": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The number of the newly created campaign" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "name": { + "type": "string", + "description": "The campaign name" + }, + "description": { + "type": "string", + "description": "The campaign description" + }, + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", + "nullable": true + }, + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "contact_link": { + "description": "The contact link of the campaign.", + "type": "string", + "format": "uri", + "nullable": true + }, + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] } }, "examples": { "default": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false + "value": [ + { + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open" }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } + { + "number": 4, + "created_at": "2024-03-30T12:29:18Z", + "updated_at": "2024-03-30T12:29:18Z", + "name": "Mitre top 10 KEV", + "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.", + "managers": [ + { + "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 + } + ], + "ends_at": "2024-04-30T12:29:18Z", + "closed_at": null, + "state": "open" + } + ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -106536,25 +105464,20 @@ } } }, - "404": { - "description": "Resource not found", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -106566,20 +105489,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } }, - "patch": { - "summary": "Update a code security configuration", - "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "post": { + "summary": "Create a campaign for an organization", + "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/update-configuration", + "operationId": "campaigns/create-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization" }, "parameters": [ { @@ -106590,15 +105513,6 @@ "schema": { "type": "string" } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -106610,248 +105524,104 @@ "additionalProperties": false, "properties": { "name": { + "description": "The name of the campaign", "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." + "minLength": 1, + "maxLength": 50 }, "description": { + "description": "A description for the campaign", "type": "string", - "description": "A description of the code security configuration", + "minLength": 1, "maxLength": 255 }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } + "managers": { + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The login of each manager", + "type": "string" } }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } + "team_managers": { + "description": "The slugs of the teams to set as the campaign managers.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The slug of each team", + "type": "string" } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { + "ends_at": { + "description": "The end date and time of the campaign. The date must be in the future.", "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "secret_scanning_delegated_bypass": { + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "nullable": true }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } + "code_scanning_alerts": { + "description": "The code scanning alerts to include in this campaign", + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "repository_id": { + "type": "integer", + "description": "The repository id" + }, + "alert_numbers": { + "type": "array", + "description": "The alert numbers", + "minItems": 1, + "items": { + "type": "integer" } } - } + }, + "required": [ + "repository_id", + "alert_numbers" + ] } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] + "generate_issues": { + "description": "If true, will automatically generate issues for the campaign. The default is false.", + "type": "boolean", + "default": false } - } + }, + "required": [ + "name", + "description", + "ends_at", + "code_scanning_alerts" + ] }, "examples": { "default": { - "summary": "Example for updating a code security configuration", "value": { - "name": "octo-org recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" + "name": "Critical CodeQL alerts", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + "octocat" + ], + "ends_at": "2024-03-14T00:00:00Z", + "code_scanning_alerts": [ + { + "repository_id": 1296269, + "alert_numbers": [ + 1, + 2 + ] + } + ] } } } @@ -106860,362 +105630,451 @@ }, "responses": { "200": { - "description": "Response when a configuration is updated", + "description": "Response", "content": { "application/json": { "schema": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", - "description": "A code security configuration", "properties": { - "id": { + "number": { "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The number of the newly created campaign" }, - "dependency_graph_autosubmit_action": { + "created_at": { "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependabot_alerts": { + "updated_at": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependabot_security_updates": { + "name": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } + "description": "The campaign name" }, - "code_scanning_default_setup": { + "description": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The campaign description" }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } + "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" + ] } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, "required": [ - "reviewer_id", - "reviewer_type" - ], + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", "properties": { - "reviewer_id": { + "id": { + "description": "Unique identifier of the team", "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "example": 1 }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "secret_scanning_delegated_alert_dismissal": { + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "private_vulnerability_reporting": { + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "nullable": true }, - "enforcement": { + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", "type": "string", - "description": "The enforcement status for a security configuration", "enum": [ - "enforced", - "unenforced" + "open", + "closed" ] }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { + "contact_link": { + "description": "The contact link of the campaign.", "type": "string", "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { - "type": "string", - "format": "date-time" + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } - } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] }, "examples": { "default": { "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings v2", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "disabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 + } } } } } } }, - "204": { - "description": "Response when no new updates are made" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" - } - }, - "delete": { - "summary": "Delete a code security configuration", - "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/delete-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "A header with no content is returned." - }, "400": { "description": "Bad Request", "content": { @@ -107239,45 +106098,11 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -107302,8 +106127,8 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -107328,25 +106153,23 @@ } } }, - "409": { - "description": "Conflict", + "429": { + "description": "Too Many Requests" + }, + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -107358,126 +106181,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" - } - } - }, - "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { - "post": { - "summary": "Attach a configuration to repositories", - "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/attach-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "scope": { - "type": "string", - "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", - "enum": [ - "all", - "all_without_configurations", - "public", - "private_or_internal", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } - } - }, - "required": [ - "scope" - ] - }, - "examples": { - "default": { - "summary": "Example for attaching a configuration to some repositories", - "value": { - "scope": "selected", - "selected_repository_ids": [ - 32, - 91 - ] - } - } - } - } - } - }, - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } } }, - "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { - "put": { - "summary": "Set a code security configuration as a default for an organization", - "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "/orgs/{org}/campaigns/{campaign_number}": { + "get": { + "summary": "Get a campaign for an organization", + "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/set-configuration-as-default", + "operationId": "campaigns/get-campaign-summary", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization" }, "parameters": [ { @@ -107490,8 +106209,8 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "campaign_number", + "description": "The campaign number.", "in": "path", "required": true, "schema": { @@ -107499,361 +106218,1074 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_for_new_repos": { - "type": "string", - "description": "Specify which types of repository this security configuration should be applied to by default.", - "enum": [ - "all", - "none", - "private_and_internal", - "public" - ] - } - } - }, - "examples": { - "default": { - "summary": "Set this configuration to be enabled by default on all new repositories.", - "value": { - "default_for_new_repos": "all" - } - } - } - } - } - }, "responses": { "200": { - "description": "Default successfully changed.", + "description": "Response", "content": { "application/json": { "schema": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", "properties": { - "default_for_new_repos": { + "number": { + "type": "integer", + "description": "The number of the newly created campaign" + }, + "created_at": { "type": "string", - "description": "Specifies which types of repository this security configuration is applied to by default.", - "enum": [ - "all", - "none", - "private_and_internal", - "public" - ] + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "configuration": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "name": { + "type": "string", + "description": "The campaign name" + }, + "description": { + "type": "string", + "description": "The campaign description" + }, + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." + "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" + ] + } + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", + "nullable": true + }, + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "contact_link": { + "description": "The contact link of the campaign.", + "type": "string", + "format": "uri", + "nullable": true + }, + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] + } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] + }, + "examples": { + "default": { + "value": { + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 + } + } + } + } + } + } + }, + "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": "Unprocessable Entity", + "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": "campaigns", + "subcategory": "campaigns" + } + }, + "patch": { + "summary": "Update a campaign", + "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/update-campaign", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "campaign_number", + "description": "The campaign number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "description": "The name of the campaign", + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "description": "A description for the campaign", + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "managers": { + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + } + }, + "team_managers": { + "description": "The slugs of the teams to set as the campaign managers.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The slug of each team", + "type": "string" + } + }, + "ends_at": { + "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", + "type": "string", + "format": "uri", + "nullable": true + }, + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + } + } + }, + "examples": { + "default": { + "value": { + "name": "Critical CodeQL alerts" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The number of the newly created campaign" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "name": { + "type": "string", + "description": "The campaign name" + }, + "description": { + "type": "string", + "description": "The campaign description" + }, + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } + "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" + ] + } + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" } - } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", + "nullable": true + }, + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "contact_link": { + "description": "The contact link of the campaign.", + "type": "string", + "format": "uri", + "nullable": true + }, + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" }, - "created_at": { - "type": "string", - "format": "date-time" + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" }, - "updated_at": { - "type": "string", - "format": "date-time" + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" } - } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } - } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] }, "examples": { "default": { "value": { - "default_for_new_repos": "all", - "configuration": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 } } } @@ -107861,8 +107293,60 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", + "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": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -107887,6 +107371,70 @@ } } }, + "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": "campaigns", + "subcategory": "campaigns" + } + }, + "delete": { + "summary": "Delete a campaign for an organization", + "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/delete-campaign", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "campaign_number", + "description": "The campaign number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Deletion successful" + }, "404": { "description": "Resource not found", "content": { @@ -107912,27 +107460,48 @@ } } } + }, + "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": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } } }, - "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + "/orgs/{org}/code-scanning/alerts": { "get": { - "summary": "Get repositories associated with a code security configuration", - "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "List code scanning alerts for an organization", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ - "code-security" + "code-scanning" ], - "operationId": "code-security/get-repositories-for-configuration", + "operationId": "code-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -107945,22 +107514,24 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." } }, { - "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).\"", + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", "in": "query", "required": false, "schema": { - "type": "integer", - "default": 30 + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } }, { @@ -107982,13 +107553,84 @@ } }, { - "name": "status", - "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "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 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", - "default": "all" + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "state", + "description": "If specified, only code scanning alerts with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "severity", + "description": "If specified, only code scanning alerts with this severity will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Severity of a code scanning alert.", + "enum": [ + "critical", + "high", + "medium", + "low", + "warning", + "note", + "error" + ] } } ], @@ -108001,22 +107643,369 @@ "type": "array", "items": { "type": "object", - "description": "Repositories associated with a code security configuration and attachment status", "properties": { - "status": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { "type": "string", - "description": "The attachment status of the code security configuration on the repository.", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "nullable": true, "enum": [ - "attached", - "attaching", - "detached", - "removed", - "enforced", - "failed", - "updating", - "removed_by_enterprise" + "open", + "dismissed", + "fixed" + ] + }, + "fixed_at": { + "type": "string", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "dismissed_at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests" ] }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "security_severity_level": { + "nullable": true, + "type": "string", + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "A description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "help": { + "nullable": true, + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "nullable": true, + "type": "string", + "description": "A link to the documentation for the rule used to detect the alert." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "category": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "nullable": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + } + } + } + }, "repository": { "title": "Simple Repository", "description": "A GitHub repository.", @@ -108435,87 +108424,874 @@ "trees_url", "url" ] + }, + "dismissal_approved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true } - } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance", + "repository" + ] } }, "examples": { "default": { - "summary": "Example of code security configuration repositories", "value": [ { - "status": "attached", + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "dismissed_comment": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", "repository": { - "value": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "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}", + "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}", + "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}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", + "repository": { + "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}", + "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}", + "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}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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" + } + } + } + } + } + }, + "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": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/orgs/{org}/code-security/configurations": { + "get": { + "summary": "Get code security configurations for an organization", + "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configurations-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "target_type", + "in": "query", + "description": "The target type of the code security configuration", + "required": false, + "schema": { + "type": "string", + "enum": [ + "global", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "in": "query", + "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).\"", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } } } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_delagated_alert_dismissal": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 17, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] + }, + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "secret_scanning_delegated_alert_dismissal": "not_set", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "organization", + "name": "High risk settings", + "description": "This is a code security configuration for octo-org high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "code_scanning_delagated_alert_dismissal": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" } ] } @@ -108582,39 +109358,654 @@ "category": "code-security", "subcategory": "configurations" } - } - }, - "/orgs/{org}/codespaces": { - "get": { - "summary": "List codespaces for the organization", - "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "post": { + "summary": "Create a code security configuration", + "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-in-organization", + "operationId": "code-security/create-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-the-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration" }, "parameters": [ { - "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", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } - }, - { - "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 + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ], + "default": "disabled" + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", + "default": false + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_options": { + "type": "object", + "description": "Security Configuration feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "not_set" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] + }, + "examples": { + "default": { + "summary": "Example for a code security configuration", + "value": { + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" + } + } + } } - }, + } + }, + "responses": { + "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations", + "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations" + }, + "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -108631,1695 +110022,370 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "codespaces" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "codespaces": { - "type": "array", - "items": { + "type": "array", + "description": "A list of default code security configurations", + "items": { + "type": "object", + "properties": { + "default_for_new_repos": { + "enum": [ + "public", + "private_and_internal", + "all" + ], + "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + }, + "configuration": { "type": "object", - "title": "Codespace", - "description": "A codespace.", + "description": "A code security configuration", "properties": { "id": { "type": "integer", - "format": "int64", - "example": 1 + "description": "The ID of the code security configuration" }, "name": { - "description": "Automatically generated name of this codespace.", "type": "string", - "example": "monalisa-octocat-hello-world-g4wpq6h95q" + "description": "The name of the code security configuration. Must be unique within the organization." }, - "display_name": { - "description": "Display name for this codespace.", + "target_type": { "type": "string", - "example": "bookish space pancake", - "nullable": true + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", + "description": { "type": "string", - "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "nullable": true + "description": "A description of the code security configuration" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { "type": "object", + "description": "Feature options for Automatic dependency submission", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } - }, - "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" + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" ] }, - "billable_owner": { - "title": "Simple User", - "description": "A GitHub user.", + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { "type": "object", + "description": "Feature options for code scanning", + "nullable": true, "properties": { - "name": { + "allow_advanced": { "nullable": true, - "type": "string" - }, - "email": { + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." }, - "user_view_type": { + "runner_label": { + "nullable": true, "type": "string", - "example": "public" + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } - }, - "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" + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" ] }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { "type": "object", + "description": "Feature options for secret scanning delegated bypass", "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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" - ] - }, - "machine": { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "example": "standardLinux" - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "example": "4 cores, 16 GB RAM, 64 GB storage" - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "example": "linux" - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "example": 68719476736 - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "example": 17179869184 - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "example": 4 - }, - "prebuild_availability": { - "type": "string", - "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", - "example": "ready", - "enum": [ - "none", - "ready", - "in_progress" - ], - "nullable": true } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ], - "nullable": true - }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", - "type": "string", - "example": ".devcontainer/example/devcontainer.json", - "nullable": true - }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": "boolean", - "example": false, - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + } }, - "last_used_at": { - "description": "Last known time this codespace was started.", + "secret_scanning_validity_checks": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "state": { - "description": "State of this codespace.", + "description": "The enablement status of secret scanning validity checks", "enum": [ - "Unknown", - "Created", - "Queued", - "Provisioning", - "Available", - "Awaiting", - "Unavailable", - "Deleted", - "Moved", - "Shutdown", - "Archived", - "Starting", - "ShuttingDown", - "Failed", - "Exporting", - "Updating", - "Rebuilding" - ], - "example": "Available", - "type": "string" + "enabled", + "disabled", + "not_set" + ] }, - "url": { - "description": "API URL for this codespace.", + "secret_scanning_non_provider_patterns": { "type": "string", - "format": "uri" - }, - "git_status": { - "description": "Details about the codespace's git repository.", - "type": "object", - "properties": { - "ahead": { - "description": "The number of commits the local repository is ahead of the remote.", - "type": "integer", - "example": 0 - }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "example": 0 - }, - "has_unpushed_changes": { - "description": "Whether the local repository has unpushed changes.", - "type": "boolean" - }, - "has_uncommitted_changes": { - "description": "Whether the local repository has uncommitted changes.", - "type": "boolean" - }, - "ref": { - "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", - "type": "string", - "example": "main" - } - } - }, - "location": { - "description": "The initally assigned location of a new codespace.", + "description": "The enablement status of secret scanning non-provider patterns", "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "example": "WestUs2", - "type": "string" - }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": "integer", - "example": 60, - "nullable": true + "enabled", + "disabled", + "not_set" + ] }, - "web_url": { - "description": "URL to access this codespace on the web.", + "secret_scanning_generic_secrets": { "type": "string", - "format": "uri" + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "machines_url": { - "description": "API URL to access available alternate machine types for this codespace.", + "secret_scanning_delegated_alert_dismissal": { "type": "string", - "format": "uri" + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "start_url": { - "description": "API URL to start this codespace.", + "private_vulnerability_reporting": { "type": "string", - "format": "uri" + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "stop_url": { - "description": "API URL to stop this codespace.", + "enforcement": { "type": "string", - "format": "uri" + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] }, - "publish_url": { - "description": "API URL to publish this codespace to a new repository.", + "url": { "type": "string", "format": "uri", - "nullable": true + "description": "The URL of the configuration" }, - "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", + "html_url": { "type": "string", "format": "uri", - "nullable": true - }, - "recent_folders": { - "type": "array", - "items": { - "type": "string" - } - }, - "runtime_constraints": { - "type": "object", - "properties": { - "allowed_port_privacy_settings": { - "description": "The privacy settings a user can select from when forwarding a port.", - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - } - }, - "pending_operation": { - "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", - "type": "boolean", - "nullable": true - }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", - "type": "string", - "nullable": true - }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", - "type": "string", - "nullable": true - }, - "retention_period_minutes": { - "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", - "type": "integer", - "example": 60, - "nullable": true + "description": "The URL of the configuration" }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "created_at": { "type": "string", - "format": "date-time", - "example": "2011-01-26T20:01:12Z", - "nullable": true + "format": "date-time" }, - "last_known_stop_notice": { - "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "updated_at": { "type": "string", - "example": "you've used 100% of your spending limit for Codespaces", - "nullable": true + "format": "date-time" } - }, - "required": [ - "id", - "name", - "environment_id", - "owner", - "billable_owner", - "repository", - "machine", - "prebuild", - "created_at", - "updated_at", - "last_used_at", - "state", - "url", - "git_status", - "location", - "idle_timeout_minutes", - "web_url", - "machines_url", - "start_url", - "stop_url", - "pulls_url", - "recent_folders" - ] + } } } } }, "examples": { "default": { - "value": { - "total_count": 3, - "codespaces": [ - { - "id": 1, - "name": "monalisa-octocat-hello-world-g4wpq6h95q", - "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "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 - }, - "billable_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 - }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", - "recent_folders": [] - }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-3f89ada1j3", - "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", - "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 - }, - "billable_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 - }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 + "value": [ + { + "default_for_new_repos": "public", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false }, - "prebuild": false, - "devcontainer_path": ".devcontainer/foobar/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", - "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": [] - }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", - "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 + "code_scanning_options": { + "allow_advanced": false }, - "billable_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 + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 1325, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + { + "default_for_new_repos": "private_and_internal", + "configuration": { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null }, - "prebuild": false, - "devcontainer_path": ".devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "code_scanning_options": { + "allow_advanced": false }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", - "recent_folders": [] + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" } - ] - } + } + ] } } } @@ -110328,58 +110394,6 @@ "304": { "description": "Not modified" }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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": { @@ -110435,23 +110449,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/codespaces/access": { - "put": { - "summary": "Manage access control for organization codespaces", - "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/code-security/configurations/detach": { + "delete": { + "summary": "Detach configurations from repositories", + "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/set-codespaces-access", + "operationId": "code-security/detach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories" }, "parameters": [ { @@ -110464,44 +110478,33 @@ } } ], - "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", + "additionalProperties": false, "properties": { - "visibility": { - "type": "string", - "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.", - "enum": [ - "disabled", - "selected_members", - "all_members", - "all_members_and_outside_collaborators" - ] - }, - "selected_usernames": { + "selected_repository_ids": { "type": "array", - "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.", + "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "minItems": 1, + "maxItems": 1000, "items": { - "type": "string" - }, - "maxItems": 100 + "type": "integer", + "description": "Unique identifier of the repository." + } } - }, - "required": [ - "visibility" - ] + } }, "examples": { "default": { + "summary": "Example for detaching repositories from configurations.", "value": { - "visibility": "selected_members", - "selected_usernames": [ - "johnDoe", - "atomIO" + "selected_repository_ids": [ + 32, + 91 ] } } @@ -110511,16 +110514,10 @@ }, "responses": { "204": { - "description": "Response when successfully modifying permissions." - }, - "304": { - "description": "Not modified" + "description": "A header with no content is returned." }, "400": { - "description": "Users are neither members nor collaborators of this organization." - }, - "404": { - "description": "Resource not found", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -110542,71 +110539,36 @@ } } } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Scim Error", + "description": "Scim Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { - "type": "string" + "type": "string", + "nullable": true }, "documentation_url": { - "type": "string" + "type": "string", + "nullable": true }, - "errors": { + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + "type": "string" } } } @@ -110614,8 +110576,8 @@ } } }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -110639,82 +110601,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" - } - } - }, - "/orgs/{org}/codespaces/access/selected_users": { - "post": { - "summary": "Add users to Codespaces access for an organization", - "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/set-codespaces-access-users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "deprecated": true, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members whose codespaces be billed to the organization.", - "items": { - "type": "string" - }, - "maxItems": 100 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "johnDoe", - "atomIO" - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response when successfully modifying permissions." - }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", @@ -110742,77 +110628,8 @@ } } }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -110840,23 +110657,24 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - }, - "delete": { - "summary": "Remove users from Codespaces access for an organization", - "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}": { + "get": { + "summary": "Get a code security configuration", + "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/delete-codespaces-access-users", + "operationId": "code-security/get-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration" }, - "deprecated": true, "parameters": [ { "name": "org", @@ -110866,53 +110684,334 @@ "schema": { "type": "string" } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members whose codespaces should not be billed to the organization.", - "items": { - "type": "string" + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" }, - "maxItems": 100 + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } } }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "johnDoe", - "atomIO" - ] + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } } } } } - } - }, - "responses": { - "204": { - "description": "Response when successfully modifying permissions." }, "304": { "description": "Not modified" }, - "400": { - "description": "Users are neither members nor collaborators of this organization." - }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -110937,18 +111036,14 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -110956,76 +111051,11 @@ "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "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" + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -111035,23 +111065,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - } - }, - "/orgs/{org}/codespaces/secrets": { - "get": { - "summary": "List organization secrets", - "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-org-secrets", + "operationId": "code-security/update-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" }, "parameters": [ { @@ -111064,224 +111092,605 @@ } }, { - "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", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Codespaces Secret", - "description": "Secrets for a GitHub Codespace.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret", - "example": "SECRET_NAME", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "secrets": [ - { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z", - "visibility": "all" + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } } - ] + } } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] } } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - } - }, - "/orgs/{org}/codespaces/secrets/public-key": { - "get": { - "summary": "Get an organization public key", - "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key" - }, - "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": "Response when a configuration is updated", "content": { "application/json": { "schema": { - "title": "CodespacesPublicKey", - "description": "The public key used for setting Codespaces secrets.", "type": "object", + "description": "A code security configuration", "properties": { - "key_id": { - "description": "The identifier for the key.", + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { "type": "string", - "example": "1234567" + "description": "The name of the code security configuration. Must be unique within the organization." }, - "key": { - "description": "The Base64 encoded public key.", + "target_type": { "type": "string", - "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "id": { - "type": "integer", - "example": 2 + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] }, "url": { "type": "string", - "example": "https://api.github.com/user/keys/2" + "format": "uri", + "description": "The URL of the configuration" }, - "title": { + "html_url": { "type": "string", - "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + "format": "uri", + "description": "The URL of the configuration" }, "created_at": { "type": "string", - "example": "2011-01-26T19:01:12Z" + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } - }, - "required": [ - "key_id", - "key" - ] + } }, "examples": { "default": { "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings v2", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "disabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" } } } } } + }, + "204": { + "description": "Response when no new updates are made" } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - } - }, - "/orgs/{org}/codespaces/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "delete": { + "summary": "Delete a code security configuration", + "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/get-org-secret", + "operationId": "code-security/delete-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration" }, "parameters": [ { @@ -111294,80 +111703,153 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "A header with no content is returned." + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "title": "Codespaces Secret", - "description": "Secrets for a GitHub Codespace.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "name": { - "description": "The name of the secret", - "example": "SECRET_NAME", + "message": { "type": "string" }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "documentation_url": { "type": "string", - "format": "date-time" + "nullable": true }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" + "detail": { + "type": "string", + "nullable": true }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "status": { + "type": "integer" + }, + "scimType": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + } + } + } + } + }, + "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" } } } } - }, - "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" + } + } + } + } + } + }, + "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" + } + } } } } @@ -111375,21 +111857,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - }, - "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach a configuration to repositories", + "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/create-or-update-org-secret", + "operationId": "code-security/attach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories" }, "parameters": [ { @@ -111402,12 +111886,12 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -111417,46 +111901,40 @@ "application/json": { "schema": { "type": "object", + "additionalProperties": false, "properties": { - "encrypted_value": { - "type": "string", - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "The ID of the key you used to encrypt the secret." - }, - "visibility": { + "scope": { "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", "enum": [ "all", - "private", + "all_without_configurations", + "public", + "private_or_internal", "selected" ] }, "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", "items": { - "type": "integer" + "type": "integer", + "description": "Unique identifier of the repository." } } }, "required": [ - "visibility" + "scope" ] }, "examples": { "default": { + "summary": "Example for attaching a configuration to some repositories", "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", + "scope": "selected", "selected_repository_ids": [ - 1296269, - 1296280 + 32, + 91 ] } } @@ -111465,16 +111943,12 @@ } }, "responses": { - "201": { - "description": "Response when creating a secret", + "202": { + "description": "Accepted", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false + "type": "object" }, "examples": { "default": { @@ -111483,48 +111957,418 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an organization", + "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/set-configuration-as-default", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "204": { - "description": "Response when updating a secret" - }, - "404": { - "description": "Resource not found", + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] }, - "status": { - "type": "string" + "configuration": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } } } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -111532,98 +112376,16 @@ "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -111654,23 +112416,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get repositories associated with a code security configuration", + "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-selected-repos-for-org-secret", + "operationId": "code-security/get-repositories-for-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" }, "parameters": [ { @@ -111683,30 +112445,50 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "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).\"", + "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", + "required": false, "schema": { "type": "integer", - "default": 1 + "default": 30 } }, { - "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).\"", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, "schema": { - "type": "integer", - "default": 30 + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "all" } } ], @@ -111716,38 +112498,50 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "type": "array", + "items": { + "type": "object", + "description": "Repositories associated with a code security configuration and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", - "example": 1296269 + "example": 1296269, + "description": "A unique identifier of the repository." }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", - "example": "Hello-World" + "example": "Hello-World", + "description": "The name of the repository." }, "full_name": { "type": "string", - "example": "octocat/Hello-World" + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", @@ -111874,549 +112668,1717 @@ ] }, "private": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true + "nullable": true, + "description": "The repository description." }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "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" + ] + } + } + } + }, + "examples": { + "default": { + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { + "value": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + } + } + ] + } + } + } + } + }, + "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": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/codespaces": { + "get": { + "summary": "List codespaces for the organization", + "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-in-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-the-organization" + }, + "parameters": [ + { + "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 + } + }, + { + "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", + "codespaces" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "codespaces": { + "type": "array", + "items": { + "type": "object", + "title": "Codespace", + "description": "A codespace.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "svn_url": { - "type": "string" + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "example": "monalisa-octocat-hello-world-g4wpq6h95q" }, - "homepage": { + "display_name": { + "description": "Display name for this codespace.", "type": "string", + "example": "bookish space pancake", "nullable": true }, - "language": { + "environment_id": { + "description": "UUID identifying this codespace's environment.", "type": "string", + "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "nullable": true }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "admin": { - "type": "boolean" + "name": { + "nullable": true, + "type": "string" }, - "maintain": { - "type": "boolean" + "email": { + "nullable": true, + "type": "string" }, - "push": { - "type": "boolean" + "login": { + "type": "string", + "example": "octocat" }, - "triage": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { + "node_id": { "type": "string", - "example": "contributor_covenant" + "example": "MDQ6VXNlcjE=" }, - "name": { + "avatar_url": { "type": "string", - "example": "Contributor Covenant" + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + "example": "https://api.github.com/users/octocat" }, - "body": { + "html_url": { "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + "format": "uri", + "example": "https://github.com/octocat" }, - "html_url": { + "followers_url": { "type": "string", "format": "uri", - "nullable": true + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ - "url", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", - "key", - "name" + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "license": { + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "key": { - "type": "string" - }, "name": { + "nullable": true, "type": "string" }, - "spdx_id": { + "email": { + "nullable": true, "type": "string" }, - "url": { - "type": "string" + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false + "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" + ] }, - "security_and_analysis": { - "nullable": true, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" } }, - "secret_scanning": { + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { "type": "object", "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } } }, - "secret_scanning_push_protection": { + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", "type": "object", "properties": { - "status": { + "key": { "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true } - } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] }, - "secret_scanning_non_provider_patterns": { + "license": { "type": "object", "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" } - } + }, + "nullable": true }, - "secret_scanning_ai_detection": { + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, "type": "object", "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } }, - "secret_scanning_validity_checks": { + "custom_properties": { "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "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" + ] + }, + "machine": { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "example": "standardLinux" + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "example": "4 cores, 16 GB RAM, 64 GB storage" + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "example": "linux" + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "example": 68719476736 + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "example": 17179869184 + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "example": 4 + }, + "prebuild_availability": { + "type": "string", + "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", + "example": "ready", + "enum": [ + "none", + "ready", + "in_progress" + ], + "nullable": true + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ], + "nullable": true + }, + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", + "type": "string", + "example": ".devcontainer/example/devcontainer.json", + "nullable": true + }, + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": "boolean", + "example": false, + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "last_used_at": { + "description": "Last known time this codespace was started.", + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "state": { + "description": "State of this codespace.", + "enum": [ + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "example": "Available", + "type": "string" + }, + "url": { + "description": "API URL for this codespace.", + "type": "string", + "format": "uri" + }, + "git_status": { + "description": "Details about the codespace's git repository.", + "type": "object", + "properties": { + "ahead": { + "description": "The number of commits the local repository is ahead of the remote.", + "type": "integer", + "example": 0 + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "example": 0 + }, + "has_unpushed_changes": { + "description": "Whether the local repository has unpushed changes.", + "type": "boolean" + }, + "has_uncommitted_changes": { + "description": "Whether the local repository has uncommitted changes.", + "type": "boolean" + }, + "ref": { + "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", + "type": "string", + "example": "main" } } }, - "custom_properties": { + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "example": "WestUs2", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": "integer", + "example": 60, + "nullable": true + }, + "web_url": { + "description": "URL to access this codespace on the web.", + "type": "string", + "format": "uri" + }, + "machines_url": { + "description": "API URL to access available alternate machine types for this codespace.", + "type": "string", + "format": "uri" + }, + "start_url": { + "description": "API URL to start this codespace.", + "type": "string", + "format": "uri" + }, + "stop_url": { + "description": "API URL to stop this codespace.", + "type": "string", + "format": "uri" + }, + "publish_url": { + "description": "API URL to publish this codespace to a new repository.", + "type": "string", + "format": "uri", + "nullable": true + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": "string", + "format": "uri", + "nullable": true + }, + "recent_folders": { + "type": "array", + "items": { + "type": "string" + } + }, + "runtime_constraints": { "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "properties": { + "allowed_port_privacy_settings": { + "description": "The privacy settings a user can select from when forwarding a port.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + }, + "pending_operation": { + "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", + "type": "boolean", + "nullable": true + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": "string", + "nullable": true + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": "string", + "nullable": true + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer", + "example": 60, + "nullable": true + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": "string", + "format": "date-time", + "example": "2011-01-26T20:01:12Z", + "nullable": true + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": "string", + "example": "you've used 100% of your spending limit for Codespaces", + "nullable": true } }, "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", + "environment_id", "owner", - "private", + "billable_owner", + "repository", + "machine", + "prebuild", + "created_at", + "updated_at", + "last_used_at", + "state", + "url", + "git_status", + "location", + "idle_timeout_minutes", + "web_url", + "machines_url", + "start_url", + "stop_url", "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" + "recent_folders" ] } } @@ -112425,13 +114387,12 @@ "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "total_count": 3, + "codespaces": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, @@ -112452,49 +114413,410 @@ "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/foobar/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "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": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-f8adfad99a", + "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", + "recent_folders": [] } ] } @@ -112503,8 +114825,11 @@ } } }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -112528,80 +114853,58 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - }, - "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/set-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "integer" + "401": { + "description": "Requires authentication", + "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": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] + } + } + } + }, + "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" + } } } } } - } - }, - "responses": { - "204": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -112628,30 +114931,27 @@ } } } - }, - "409": { - "description": "Conflict when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", - "subcategory": "organization-secrets" + "subcategory": "organizations" } } }, - "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + "/orgs/{org}/codespaces/access": { "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Manage access control for organization codespaces", + "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], - "operationId": "codespaces/add-selected-repo-to-org-secret", + "operationId": "codespaces/set-codespaces-access", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces" }, "parameters": [ { @@ -112662,28 +114962,62 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "deprecated": true, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "visibility": { + "type": "string", + "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.", + "enum": [ + "disabled", + "selected_members", + "all_members", + "all_members_and_outside_collaborators" + ] + }, + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.", + "items": { + "type": "string" + }, + "maxItems": 100 + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "visibility": "selected_members", + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + } + } + } + } + } + }, "responses": { "204": { - "description": "No Content when repository was added to the selected list" + "description": "Response when successfully modifying permissions." + }, + "304": { + "description": "Not modified" + }, + "400": { + "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", @@ -112711,9 +115045,6 @@ } } }, - "409": { - "description": "Conflict when visibility type is not set to selected" - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -112782,25 +115113,53 @@ } } } - } - }, - "x-github": { + }, + "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" + } + } + } + } + } + } + }, + "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", - "subcategory": "organization-secrets" + "subcategory": "organizations" } - }, - "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/codespaces/access/selected_users": { + "post": { + "summary": "Add users to Codespaces access for an organization", + "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], - "operationId": "codespaces/remove-selected-repo-from-org-secret", + "operationId": "codespaces/set-codespaces-access-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" }, "parameters": [ { @@ -112811,28 +115170,246 @@ "schema": { "type": "string" } + } + ], + "deprecated": true, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members whose codespaces be billed to the organization.", + "items": { + "type": "string" + }, + "maxItems": 100 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response when successfully modifying permissions." }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "304": { + "description": "Not modified" + }, + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } } }, + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" + } + }, + "delete": { + "summary": "Remove users from Codespaces access for an organization", + "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-codespaces-access-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" + }, + "deprecated": true, + "parameters": [ { - "name": "repository_id", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members whose codespaces should not be billed to the organization.", + "items": { + "type": "string" + }, + "maxItems": 100 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + } + } + } + } + } + }, "responses": { "204": { - "description": "Response when repository was removed from the selected list" + "description": "Response when successfully modifying permissions." + }, + "304": { + "description": "Not modified" + }, + "400": { + "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", @@ -112860,9 +115437,6 @@ } } }, - "409": { - "description": "Conflict when visibility type not set to selected" - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -112931,27 +115505,53 @@ } } } + }, + "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" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", - "subcategory": "organization-secrets" + "subcategory": "organizations" } } }, - "/orgs/{org}/copilot/billing": { + "/orgs/{org}/codespaces/secrets": { "get": { - "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "summary": "List organization secrets", + "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/get-copilot-organization-details", + "operationId": "codespaces/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets" }, "parameters": [ { @@ -112962,162 +115562,433 @@ "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": "OK", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Copilot Organization Details", - "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", "type": "object", + "required": [ + "total_count", + "secrets" + ], "properties": { - "seat_breakdown": { - "title": "Copilot Seat Breakdown", - "description": "The breakdown of Copilot Business seats for the organization.", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "The total number of seats being billed for the organization as of the current billing cycle." - }, - "added_this_cycle": { - "type": "integer", - "description": "Seats added during the current billing cycle." - }, - "pending_cancellation": { - "type": "integer", - "description": "The number of seats that are pending cancellation at the end of the current billing cycle." - }, - "pending_invitation": { - "type": "integer", - "description": "The number of users who have been invited to receive a Copilot seat through this organization." + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret", + "example": "SECRET_NAME", + "type": "string" + }, + "created_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "The type of repositories in the organization that the secret is visible to", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + } }, - "active_this_cycle": { - "type": "integer", - "description": "The number of seats that have used Copilot during the current billing cycle." + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" }, - "inactive_this_cycle": { - "type": "integer", - "description": "The number of seats that have not used Copilot during the current billing cycle." + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z", + "visibility": "all" } - } - }, - "public_code_suggestions": { - "type": "string", - "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", - "enum": [ - "allow", - "block", - "unconfigured" ] - }, - "ide_chat": { + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key" + }, + "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": "CodespacesPublicKey", + "description": "The public key used for setting Codespaces secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", "type": "string", - "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] + "example": "1234567" }, - "platform_chat": { + "key": { + "description": "The Base64 encoded public key.", "type": "string", - "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" }, - "cli": { + "id": { + "type": "integer", + "example": 2 + }, + "url": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] + "example": "https://api.github.com/user/keys/2" }, - "seat_management_setting": { + "title": { "type": "string", - "description": "The mode of assigning new seats.", - "enum": [ - "assign_all", - "assign_selected", - "disabled", - "unconfigured" - ] + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" }, - "plan_type": { + "created_at": { "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise" - ] + "example": "2011-01-26T19:01:12Z" } }, "required": [ - "seat_breakdown", - "public_code_suggestions", - "seat_management_setting" - ], - "additionalProperties": true + "key_id", + "key" + ] }, "examples": { "default": { "value": { - "seat_breakdown": { - "total": 12, - "added_this_cycle": 9, - "pending_invitation": 0, - "pending_cancellation": 0, - "active_this_cycle": 12, - "inactive_this_cycle": 11 - }, - "seat_management_setting": "assign_selected", - "ide_chat": "enabled", - "platform_chat": "enabled", - "cli": "enabled", - "public_code_suggestions": "block", - "plan_type": "business" + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "500": { - "description": "Internal Error", + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the secret", + "example": "SECRET_NAME", "type": "string" }, - "documentation_url": { - "type": "string" + "created_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" }, - "url": { - "type": "string" + "updated_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" }, - "status": { + "visibility": { + "description": "The type of repositories in the organization that the secret is visible to", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "401": { - "description": "Requires authentication", + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "The ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -113142,14 +116013,18 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -113157,16 +116032,98 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -113193,30 +116150,27 @@ } } } - }, - "422": { - "description": "There is a problem with your account's associated payment method." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/copilot/billing/seats": { + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { "get": { - "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/list-copilot-seats", + "operationId": "codespaces/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -113228,6 +116182,15 @@ "type": "string" } }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "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).\"", @@ -113243,7 +116206,7 @@ "in": "query", "schema": { "type": "integer", - "default": 50 + "default": 30 } } ], @@ -113254,19 +116217,39 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "repositories" + ], "properties": { - "total_seats": { - "type": "integer", - "description": "Total number of Copilot seats for the organization currently being billed." + "total_count": { + "type": "integer" }, - "seats": { + "repositories": { "type": "array", "items": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "assignee": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -113388,371 +116371,553 @@ "subscriptions_url", "type", "url" - ], + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { "type": "object", "properties": { - "login": { - "type": "string", - "example": "github" + "admin": { + "type": "boolean" }, - "id": { - "type": "integer", - "example": 1 + "maintain": { + "type": "boolean" }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "push": { + "type": "boolean" }, - "url": { + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" + "example": "contributor_covenant" }, - "repos_url": { + "name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" + "example": "Contributor Covenant" }, - "events_url": { + "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/orgs/github/events" + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, - "hooks_url": { + "body": { "type": "string", - "example": "https://api.github.com/orgs/github/hooks" + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, - "issues_url": { + "html_url": { "type": "string", - "example": "https://api.github.com/orgs/github/issues" + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" + "name": { + "type": "string" }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" + "spdx_id": { + "type": "string" }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" + "url": { + "type": "string" }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true + "node_id": { + "type": "string" } }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ], "nullable": true }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { + "status": { "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" + "enum": [ + "enabled", + "disabled" ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] + } }, - { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", + "code_security": { "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { + "status": { "type": "string", - "example": "disabled | all" - }, - "organization_selection_type": { + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", - "example": "disabled | all" - }, - "group_id": { - "nullable": true, + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" - }, - "group_name": { - "nullable": true, + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { "type": "string", - "example": "Justice League" - }, - "html_url": { + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/dc/teams/justice-league" - }, - "members_url": { - "type": "string" - }, - "created_at": { + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "date-time" - }, - "updated_at": { + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "date-time" + "enum": [ + "enabled", + "disabled" + ] } - }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at" - ] + } } - ], - "nullable": true - }, - "pending_cancellation_date": { - "type": "string", - "format": "date", - "nullable": true, - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": "string", - "nullable": true, - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + } }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" - ] + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "created_at" - ], - "additionalProperties": false + "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" + ] } } } @@ -113760,16 +116925,14 @@ "examples": { "default": { "value": { - "total_seats": 2, - "seats": [ + "total_count": 1, + "repositories": [ { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "plan_type": "business", - "assignee": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -113789,66 +116952,59 @@ "type": "User", "site_admin": false }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -113872,58 +117028,80 @@ } } } - }, - "401": { - "description": "Requires authentication", - "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": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "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" + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" } } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } } } } + } + }, + "responses": { + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -113950,27 +117128,30 @@ } } } + }, + "409": { + "description": "Conflict when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/copilot/billing/selected_teams": { - "post": { - "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/add-copilot-seats-for-teams", + "operationId": "codespaces/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -113981,10 +117162,1329 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "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 when visibility type is not set to selected" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "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 when visibility type not set to selected" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/copilot/billing": { + "get": { + "summary": "Get Copilot seat information and settings for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/get-copilot-organization-details", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-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": "OK", + "content": { + "application/json": { + "schema": { + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", + "type": "object", + "properties": { + "seat_breakdown": { + "title": "Copilot Seat Breakdown", + "description": "The breakdown of Copilot Business seats for the organization.", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of seats being billed for the organization as of the current billing cycle." + }, + "added_this_cycle": { + "type": "integer", + "description": "Seats added during the current billing cycle." + }, + "pending_cancellation": { + "type": "integer", + "description": "The number of seats that are pending cancellation at the end of the current billing cycle." + }, + "pending_invitation": { + "type": "integer", + "description": "The number of users who have been invited to receive a Copilot seat through this organization." + }, + "active_this_cycle": { + "type": "integer", + "description": "The number of seats that have used Copilot during the current billing cycle." + }, + "inactive_this_cycle": { + "type": "integer", + "description": "The number of seats that have not used Copilot during the current billing cycle." + } + } + }, + "public_code_suggestions": { + "type": "string", + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" + ] + }, + "ide_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "platform_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "cli": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "seat_management_setting": { + "type": "string", + "description": "The mode of assigning new seats.", + "enum": [ + "assign_all", + "assign_selected", + "disabled", + "unconfigured" + ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise" + ] + } + }, + "required": [ + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true + }, + "examples": { + "default": { + "value": { + "seat_breakdown": { + "total": 12, + "added_this_cycle": 9, + "pending_invitation": 0, + "pending_cancellation": 0, + "active_this_cycle": 12, + "inactive_this_cycle": 11 + }, + "seat_management_setting": "assign_selected", + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "There is a problem with your account's associated payment method." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/seats": { + "get": { + "summary": "List all Copilot seat assignments for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/list-copilot-seats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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": 50 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_seats": { + "type": "integer", + "description": "Total number of Copilot seats for the organization currently being billed." + }, + "seats": { + "type": "array", + "items": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "type": "object", + "properties": { + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ], + "nullable": true + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "organization_selection_type": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "string", + "example": "62ab9291-fae2-468e-974b-7e45096d5021" + }, + "group_name": { + "nullable": true, + "type": "string", + "example": "Justice League" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] + } + ], + "nullable": true + }, + "pending_cancellation_date": { + "type": "string", + "format": "date", + "nullable": true, + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": "string", + "nullable": true, + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] + } + }, + "required": [ + "created_at" + ], + "additionalProperties": false + } + } + } + }, + "examples": { + "default": { + "value": { + "total_seats": 2, + "seats": [ + { + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "plan_type": "business", + "assignee": { + "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 + }, + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/selected_teams": { + "post": { + "summary": "Add teams to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-copilot-seats-for-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "type": "object", @@ -125874,6 +130374,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -137257,6 +141781,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -141639,7 +146187,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -178177,6 +182725,639 @@ } } }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "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": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update organization pattern configurations", + "description": "Updates the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "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": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, "/orgs/{org}/security-advisories": { "get": { "summary": "List repository security advisories for an organization", @@ -211575,6 +216756,851 @@ } } }, + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for a repository", + "description": "Gets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "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": { + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "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" + } + }, + "put": { + "summary": "Set artifact and log retention settings for a repository", + "description": "Sets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "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": { + "default": { + "summary": "Set retention days", + "value": { + "days": 90 + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for a repository", + "description": "Gets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for a repository", + "description": "Sets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for a repository", + "description": "Gets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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 + } + } + } + } + } + }, + "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, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for a repository", + "description": "Sets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/repos/{owner}/{repo}/actions/permissions/selected-actions": { "get": { "summary": "Get allowed actions and reusable workflows for a repository", @@ -322178,6 +328204,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -342050,6 +348100,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -344623,6 +350697,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -350630,6 +356728,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -351784,9 +357906,6310 @@ "value": [ { "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "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 + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/events/{event_id}": { + "get": { + "summary": "Get an issue event", + "description": "Gets a single event by the event id.", + "tags": [ + "issues" + ], + "operationId": "issues/get-event", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "event_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue Event", + "description": "Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEwOklzc3VlRXZlbnQx" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "event": { + "type": "string", + "example": "closed" + }, + "commit_id": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "commit_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ], + "nullable": true + }, + "label": { + "title": "Issue Event Label", + "description": "Issue Event Label", + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "color" + ] + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assigner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "review_requester": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "requested_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "requested_team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "dismissed_review": { + "title": "Issue Event Dismissed Review", + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": "string", + "nullable": true + }, + "dismissal_commit_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" + ] + }, + "milestone": { + "title": "Issue Event Milestone", + "description": "Issue Event Milestone", + "type": "object", + "properties": { + "title": { + "type": "string" + } + }, + "required": [ + "title" + ] + }, + "project_card": { + "title": "Issue Event Project Card", + "description": "Issue Event Project Card", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "url", + "id", + "project_url", + "project_id", + "column_name" + ] + }, + "rename": { + "title": "Issue Event Rename", + "description": "Issue Event Rename", + "type": "object", + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + }, + "required": [ + "from", + "to" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "lock_reason": { + "type": "string", + "nullable": true + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "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 + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "performed_via_github_app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "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", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "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", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}": { + "get": { + "summary": "Get an issue", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -351805,176 +364228,119 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "issue": { - "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "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 - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "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 - }, - "assignees": [ - { - "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 - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR", - "state_reason": "completed" } - } - ] + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -351982,76 +364348,64 @@ "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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" } } } } } + }, + "304": { + "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "events" + "subcategory": "issues" } - } - }, - "/repos/{owner}/{repo}/issues/events/{event_id}": { - "get": { - "summary": "Get an issue event", - "description": "Gets a single event by the event id.", + }, + "patch": { + "summary": "Update an issue", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/get-event", + "operationId": "issues/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue" }, "parameters": [ { @@ -352073,7 +364427,8 @@ } }, { - "name": "event_id", + "name": "issue_number", + "description": "The number that identifies the issue.", "in": "path", "required": true, "schema": { @@ -352081,31 +364436,207 @@ } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "description": "The title of the issue.", + "nullable": true + }, + "body": { + "type": "string", + "description": "The contents of the issue.", + "nullable": true + }, + "assignee": { + "type": "string", + "nullable": true, + "description": "Username to assign to this issue. **This field is closing down.**" + }, + "state": { + "type": "string", + "description": "The open or closed state of the issue.", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "enum": [ + "completed", + "not_planned", + "duplicate", + "reopened" + ], + "nullable": true, + "description": "The reason for the state change. Ignored unless `state` is changed.", + "example": "not_planned" + }, + "milestone": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer", + "description": "The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped." + } + ], + "nullable": true + }, + "labels": { + "type": "array", + "description": "Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + } + } + ] + } + }, + "assignees": { + "type": "array", + "description": "Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.", + "nullable": true, + "example": "Epic" + } + } + }, + "examples": { + "default": { + "value": { + "title": "Found a bug", + "body": "I'm having a problem with this.", + "assignees": [ + "octocat" + ], + "milestone": 1, + "state": "open", + "labels": [ + "bug" + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Issue Event", - "description": "Issue Event", + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { - "type": "string", - "example": "MDEwOklzc3VlRXZlbnQx" + "type": "string" }, "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + "format": "uri" }, - "actor": { + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -352230,96 +364761,358 @@ ], "nullable": true }, - "event": { - "type": "string", - "example": "closed" - }, - "commit_id": { - "type": "string", - "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true - }, - "commit_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "example": 1 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "repository_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://github.com/octocat" }, - "labels_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "comments_url": { + "following_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", "type": "string", - "nullable": true, "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] + "open", + "closed" + ], + "default": "open" }, "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "description": "The title of the milestone.", + "example": "v1.0", "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "description": { "type": "string", + "example": "Tracking milestone for version 1.0", "nullable": true }, - "user": { + "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -352444,52 +365237,409 @@ ], "nullable": true }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } + "nullable": true }, - "assignee": { + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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", @@ -352611,718 +365761,546 @@ "subscriptions_url", "type", "url" - ], + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true }, - "assignees": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - "nullable": true + "type": "string" + } }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", "nullable": true }, - "locked": { - "type": "boolean" + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true }, - "active_lock_reason": { + "updated_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", "nullable": true }, - "comments": { - "type": "integer" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "temp_clone_token": { + "type": "string" }, - "closed_at": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", - "format": "date-time", - "nullable": true + "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)." }, - "created_at": { + "squash_merge_commit_message": { "type": "string", - "format": "date-time" + "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." }, - "updated_at": { + "merge_commit_title": { "type": "string", - "format": "date-time" + "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)." }, - "draft": { + "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", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" }, - "body_html": { - "type": "string" + "open_issues": { + "type": "integer" }, - "body_text": { + "watchers": { + "type": "integer" + }, + "master_branch": { "type": "string" }, - "timeline_url": { + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:42Z\"" }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { "type": "object", - "nullable": true, + "description": "The status of the code search index for this repository", "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" + "lexical_search_ok": { + "type": "boolean" }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "lexical_commit_sha": { + "type": "string" } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + } + } + }, + "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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -353446,957 +366424,813 @@ "url" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", - "description": "The status of the code search index for this repository", "properties": { - "lexical_search_ok": { - "type": "boolean" + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true }, - "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" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" }, - "checks": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" }, - "metadata": { - "type": "string" + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "contents": { - "type": "string" + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" }, - "deployments": { - "type": "string" + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" ] }, - "author_association": { - "title": "author_association", + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "example": "The description of the app.", + "nullable": true }, - "reactions": { - "title": "Reaction Rollup", + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" + "issues": { + "type": "string" }, - "heart": { - "type": "integer" + "checks": { + "type": "string" }, - "hooray": { - "type": "integer" + "metadata": { + "type": "string" }, - "eyes": { - "type": "integer" + "contents": { + "type": "string" }, - "rocket": { - "type": "integer" + "deployments": { + "type": "string" } }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } + "additionalProperties": { + "type": "string" }, - "required": [ - "total", - "completed", - "percent_completed" - ] + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", + "owner", + "name", + "description", + "external_url", + "html_url", "created_at", - "updated_at" + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } ], - "nullable": true + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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": "issues", + "subcategory": "issues" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + "post": { + "summary": "Add assignees to an issue", + "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", + "tags": [ + "issues" + ], + "operationId": "issues/add-assignees", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "type": "array", + "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "assignees": [ + "hubot", + "other_user" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - } - }, - "required": [ - "name", - "color" + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" ] }, - "assignee": { + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -354521,7 +367355,52 @@ ], "nullable": true }, - "assigner": { + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -354646,132 +367525,426 @@ ], "nullable": true }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, - "email": { - "nullable": true, - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, - "login": { + "labels_url": { "type": "string", - "example": "octocat" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { "type": "integer", - "format": "int64", - "example": 1 + "example": 1002604 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, - "gravatar_id": { + "state": { + "description": "The state of the milestone.", + "example": "open", "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "enum": [ + "open", + "closed" + ], + "default": "open" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" }, - "html_url": { + "description": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "Tracking milestone for version 1.0", + "nullable": true }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "open_issues": { + "type": "integer", + "example": 4 }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "closed_issues": { + "type": "integer", + "example": 8 }, - "starred_url": { + "created_at": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "date-time", + "example": "2011-04-10T20:09:31Z" }, - "subscriptions_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, - "organizations_url": { + "closed_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true }, - "repos_url": { + "due_on": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "nullable": true }, - "received_events_url": { + "diff_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "nullable": true }, - "type": { + "html_url": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "nullable": true }, - "starred_at": { + "patch_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri", + "nullable": true }, - "user_view_type": { + "url": { "type": "string", - "example": "public" + "format": "uri", + "nullable": true } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "diff_url", "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "patch_url", "url" - ], + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", "nullable": true }, - "requested_reviewer": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -354896,39 +368069,151 @@ ], "nullable": true }, - "requested_team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": "object", + "nullable": true, "properties": { "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue type." }, "node_id": { - "type": "string" + "type": "string", + "description": "The node identifier of the issue type." }, "name": { - "type": "string" - }, - "slug": { - "type": "string" + "type": "string", + "description": "The name of the issue type." }, "description": { "type": "string", + "description": "The description of the issue type.", "nullable": true }, - "privacy": { - "type": "string" + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, - "notification_setting": { - "type": "string" + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" }, - "permission": { - "type": "string" + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" }, "permissions": { "type": "object", "properties": { + "admin": { + "type": "boolean" + }, "pull": { "type": "boolean" }, @@ -354940,243 +368225,649 @@ }, "maintain": { "type": "boolean" - }, - "admin": { - "type": "boolean" } }, "required": [ + "admin", "pull", - "triage", - "push", - "maintain", - "admin" + "push" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { - "description": "Unique identifier of the team", "type": "integer", + "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VGVhbTE=" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { - "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" + "example": "https://api.github.com/users/octocat" }, - "members_url": { + "html_url": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "format": "uri", + "example": "https://github.com/octocat" }, - "name": { - "description": "Name of the team", + "followers_url": { "type": "string", - "example": "Justice League" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "description": { - "description": "Description of the team", + "following_url": { "type": "string", - "nullable": true, - "example": "A great team." + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "permission": { - "description": "Permission that the team will have for its repositories", + "gists_url": { "type": "string", - "example": "admin" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "privacy": { - "description": "The level of privacy this team should have", + "starred_url": { "type": "string", - "example": "closed" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "notification_setting": { - "description": "The notification setting the team has set", + "subscriptions_url": { "type": "string", - "example": "notifications_enabled" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "example": "https://api.github.com/users/octocat/orgs" }, - "repositories_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "example": "https://api.github.com/users/octocat/repos" }, - "slug": { + "events_url": { "type": "string", - "example": "justice-league" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - "dismissed_review": { - "title": "Issue Event Dismissed Review", - "type": "object", - "properties": { - "state": { + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "review_id": { - "type": "integer" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true }, - "dismissal_message": { + "created_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", "nullable": true }, - "dismissal_commit_id": { + "updated_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", "nullable": true - } - }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] - }, - "milestone": { - "title": "Issue Event Milestone", - "description": "Issue Event Milestone", - "type": "object", - "properties": { - "title": { + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { "type": "string" - } - }, - "required": [ - "title" - ] - }, - "project_card": { - "title": "Issue Event Project Card", - "description": "Issue Event Project Card", - "type": "object", - "properties": { - "url": { + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", - "format": "uri" + "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)." }, - "id": { - "type": "integer" + "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." }, - "project_url": { + "merge_commit_title": { "type": "string", - "format": "uri" + "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)." }, - "project_id": { + "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", + "example": 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" }, - "column_name": { - "type": "string" + "watchers": { + "type": "integer" }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "project_url", - "project_id", - "column_name" - ] - }, - "rename": { - "title": "Issue Event Rename", - "description": "Issue Event Rename", - "type": "object", - "properties": { - "from": { + "master_branch": { "type": "string" }, - "to": { - "type": "string" + "starred_at": { + "type": "string", + "example": "\"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": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "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" ] }, - "lock_reason": { - "type": "string", - "nullable": true - }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -355485,26 +369176,157 @@ "permissions", "events" ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at" + "user", + "author_association", + "created_at", + "updated_at" ] }, "examples": { "default": { "value": { "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -355524,24 +369346,39 @@ "type": "User", "site_admin": false }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "issue": { + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { + "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 + }, + "assignees": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -355560,19 +369397,19 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -355592,198 +369429,47 @@ "type": "User", "site_admin": false }, - "assignees": [ - { - "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 - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "performed_via_github_app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "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", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "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" + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -355795,21 +369481,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "events" + "subcategory": "assignees" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}": { - "get": { - "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + }, + "delete": { + "summary": "Remove assignees from an issue", + "description": "Removes one or more assignees from an issue.", "tags": [ "issues" ], - "operationId": "issues/get", + "operationId": "issues/remove-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue" }, "parameters": [ { @@ -355840,6 +369524,34 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "type": "array", + "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "assignees": [ + "hubot", + "other_user" + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", @@ -357946,6 +371658,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -358136,9 +371872,71 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + "get": { + "summary": "Check if a user can be assigned to a issue", + "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", + "tags": [ + "issues" + ], + "operationId": "issues/check-user-can-be-assigned-to-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "301": { - "description": "Moved permanently", + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "assignee", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if `assignee` can be assigned to `issue_number`" + }, + "404": { + "description": "Response if `assignee` can not be assigned to `issue_number`", "content": { "application/json": { "schema": { @@ -358162,6 +371960,701 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "get": { + "summary": "List issue comments", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-comments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "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": "array", + "items": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "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 + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } }, "404": { "description": "Resource not found", @@ -358214,28 +372707,25 @@ } } } - }, - "304": { - "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "comments" } }, - "patch": { - "summary": "Update an issue", - "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "post": { + "summary": "Create an issue comment", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/update", + "operationId": "issues/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment" }, "parameters": [ { @@ -358267,124 +372757,25 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "The title of the issue.", - "nullable": true - }, "body": { "type": "string", - "description": "The contents of the issue.", - "nullable": true - }, - "assignee": { - "type": "string", - "nullable": true, - "description": "Username to assign to this issue. **This field is closing down.**" - }, - "state": { - "type": "string", - "description": "The open or closed state of the issue.", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": "string", - "enum": [ - "completed", - "not_planned", - "duplicate", - "reopened" - ], - "nullable": true, - "description": "The reason for the state change. Ignored unless `state` is changed.", - "example": "not_planned" - }, - "milestone": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped." - } - ], - "nullable": true - }, - "labels": { - "type": "array", - "description": "Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - } - } - } - ] - } - }, - "assignees": { - "type": "array", - "description": "Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.", - "nullable": true, - "example": "Epic" + "description": "The contents of the comment." } - } + }, + "required": [ + "body" + ] }, "examples": { "default": { "value": { - "title": "Found a bug", - "body": "I'm having a problem with this.", - "assignees": [ - "octocat" - ], - "milestone": 1, - "state": "open", - "labels": [ - "bug" - ] + "body": "Me too" } } } @@ -358392,16 +372783,18 @@ } }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the issue comment", + "example": 42, "type": "integer", "format": "int64" }, @@ -358409,62 +372802,25 @@ "type": "string" }, "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", "format": "uri" }, - "labels_url": { + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", "type": "string" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", + "body_text": { "type": "string" }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", - "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] - }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "body_html": { "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "html_url": { "type": "string", - "nullable": true + "format": "uri" }, "user": { "title": "Simple User", @@ -358591,179 +372947,747 @@ ], "nullable": true }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", + "nullable": true, "properties": { - "name": { - "nullable": true, - "type": "string" + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" }, - "email": { - "nullable": true, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", "type": "string" }, - "login": { + "node_id": { "type": "string", - "example": "octocat" + "example": "MDExOkludGVncmF0aW9uMQ==" }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" }, - "node_id": { + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "The description of the app.", + "nullable": true }, - "avatar_url": { + "external_url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "https://example.com" }, - "gravatar_id": { + "html_url": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "total_count": { + "type": "integer" }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "+1": { + "type": "integer" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "-1": { + "type": "integer" }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "laugh": { + "type": "integer" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "confused": { + "type": "integer" }, - "type": { - "type": "string", - "example": "User" + "heart": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "hooray": { + "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "eyes": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "example": "public" + "rocket": { + "type": "integer" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "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 + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "assignees": { + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + "get": { + "summary": "List dependencies an issue is blocked by", + "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -358885,64 +373809,182 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "creator": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -359064,1533 +374106,1686 @@ "subscriptions_url", "type", "url" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true + ] }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } + "nullable": true }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "locked": { + "type": "boolean" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } + "active_lock_reason": { + "type": "string", + "nullable": true }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "html_url": { - "type": "string", - "format": "uri" + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" } }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, - "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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" + }, + "starred_at": { + "type": "string", + "example": "\"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" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "required": [ + "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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user_view_type": { - "type": "string", - "example": "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" + ] }, - "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "contents": { + "additionalProperties": { "type": "string" }, - "deployments": { - "type": "string" + "example": { + "issues": "read", + "deployments": "write" } }, - "additionalProperties": { - "type": "string" + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } }, - "example": { - "issues": "read", - "deployments": "write" + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } }, - "rocket": { - "type": "integer" - } + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at" - ] + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } }, "examples": { "default": { - "value": { - "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "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 - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "login": "octocat", + "value": [ + { "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 - }, - "assignees": [ - { + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -360609,19 +375804,19 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -360641,165 +375836,110 @@ "type": "User", "site_admin": false }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "closed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - } - } - } - }, - "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" + "assignees": [ + { + "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 + } ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } + ] } } } - } - }, - "403": { - "description": "Forbidden", - "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" } } } @@ -360887,21 +376027,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "issue-dependencies" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + }, "post": { - "summary": "Add assignees to an issue", - "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", + "summary": "Add a dependency an issue is blocked by", + "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/add-assignees", + "operationId": "issues/add-blocked-by-dependency", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -360933,28 +376071,25 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "assignees": { - "type": "array", - "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "items": { - "type": "string" - } + "issue_id": { + "type": "integer", + "description": "The id of the issue that blocks the current issue" } - } + }, + "required": [ + "issue_id" + ] }, "examples": { "default": { "value": { - "assignees": [ - "hubot", - "other_user" - ] + "issue_id": 1 } } } @@ -363067,6 +378202,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -363256,26 +378415,210 @@ } } } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" + } + } + } + } } } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "assignees" + "subcategory": "issue-dependencies" } - }, + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { "delete": { - "summary": "Remove assignees from an issue", - "description": "Removes one or more assignees from an issue.", + "summary": "Remove dependency an issue is blocked by", + "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/remove-assignees", + "operationId": "issues/remove-dependency-blocked-by", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -363304,36 +378647,17 @@ "schema": { "type": "integer" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "assignees": { - "type": "array", - "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "assignees": [ - "hubot", - "other_user" - ] - } - } - } + }, + { + "name": "issue_id", + "in": "path", + "description": "The id of the blocking issue to remove as a dependency", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { "200": { "description": "Response", @@ -365440,6 +380764,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -365630,71 +380978,173 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "assignees" - } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { - "get": { - "summary": "Check if a user can be assigned to a issue", - "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", - "tags": [ - "issues" - ], - "operationId": "issues/check-user-can-be-assigned-to-issue", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "301": { + "description": "Moved permanently", + "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" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } } }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" + "401": { + "description": "Requires authentication", + "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": "assignee", - "in": "path", - "required": true, - "schema": { - "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" + } + } + } + } } - } - ], - "responses": { - "204": { - "description": "Response if `assignee` can be assigned to `issue_number`" }, "404": { - "description": "Response if `assignee` can not be assigned to `issue_number`", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -365721,24 +381171,25 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "assignees" + "subcategory": "issue-dependencies" } } }, - "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { "get": { - "summary": "List issue comments", - "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "summary": "List dependencies an issue is blocking", + "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/list-comments", + "operationId": "issues/list-dependencies-blocking", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" }, "parameters": [ { @@ -365768,16 +381219,6 @@ "type": "integer" } }, - { - "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, { "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).\"", @@ -365805,13 +381246,11 @@ "schema": { "type": "array", "items": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the issue comment", - "example": 42, "type": "integer", "format": "int64" }, @@ -365819,26 +381258,63 @@ "type": "string" }, "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" + "repository_url": { + "type": "string", + "format": "uri" }, - "body_text": { + "labels_url": { "type": "string" }, - "body_html": { - "type": "string" + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, "user": { "title": "Simple User", "description": "A GitHub user.", @@ -365964,34 +381440,1517 @@ ], "nullable": true }, - "created_at": { + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { "type": "string", "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "format": "date-time" }, - "issue_url": { + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { "type": "string", "format": "uri" }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" ] }, "performed_via_github_app": { @@ -366303,6 +383262,22 @@ "events" ] }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, "reactions": { "title": "Reaction Rollup", "type": "object", @@ -366351,16 +383326,72 @@ "eyes", "rocket" ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", - "html_url", - "issue_url", - "author_association", - "user", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", + "user", + "author_association", "created_at", "updated_at" ] @@ -366371,10 +383402,17 @@ "value": [ { "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, @@ -366395,10 +383433,130 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -366414,6 +383572,32 @@ } } }, + "301": { + "description": "Moved permanently", + "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": { @@ -366471,841 +383655,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "comments" - } - }, - "post": { - "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", - "tags": [ - "issues" - ], - "operationId": "issues/create-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "The contents of the comment." - } - }, - "required": [ - "body" - ] - }, - "examples": { - "default": { - "value": { - "body": "Me too" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "user": { - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "schema": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "comments" + "subcategory": "issue-dependencies" } } }, @@ -380952,6 +397302,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -383414,6 +399788,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -385852,6 +402250,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -388389,6 +404811,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -398933,6 +415379,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -507681,6 +524151,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "type": "string" }, @@ -552363,6 +568857,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -582124,6 +598642,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -585105,6 +601647,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -588088,6 +604654,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -597461,6 +614051,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -600444,6 +617058,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -796344,6 +812982,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -800085,6 +816747,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -803850,6 +820536,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -808021,6 +824731,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -810152,6 +826886,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -814560,6 +831318,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -816691,6 +833473,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -821099,6 +837905,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -823959,6 +840789,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -827638,6 +844492,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -830498,6 +847376,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -833321,6 +850223,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -836211,6 +853137,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -839293,6 +856243,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -842193,6 +859167,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -845266,6 +862264,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -848190,6 +865212,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -851140,6 +868186,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -854016,6 +871086,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -856970,6 +874064,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -858923,6 +876041,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -861801,6 +878943,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -864704,6 +881870,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -867474,6 +884664,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -869443,6 +886657,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -872328,6 +889566,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -875371,6 +892633,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -878256,6 +895542,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -881204,6 +898514,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -884059,6 +901393,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -886943,6 +904301,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -974251,6 +991633,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -975017,6 +992594,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -975783,6 +993555,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -976602,6 +994569,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -981135,6 +999297,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1235931,6 +1254288,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1238791,6 +1257172,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1242467,6 +1260872,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1245327,6 +1263756,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1249003,6 +1267456,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1251863,6 +1270340,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1255539,6 +1274040,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1258399,6 +1276924,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 9e9656c3cf..831bd9057b 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -107,6 +107,8 @@ tags: description: Endpoints to manage campaigns via the REST API. - name: credentials description: Revoke compromised or leaked GitHub credentials. +- name: projects + description: Endpoints to manage Projects using the REST API. servers: - url: https://api.github.com externalDocs: @@ -442,7 +444,7 @@ paths: The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - - &89 + - &91 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For @@ -451,7 +453,7 @@ paths: required: false schema: type: string - - &90 + - &92 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For @@ -460,7 +462,7 @@ paths: required: false schema: type: string - - &91 + - &93 name: direction description: The direction to sort the results by. in: query @@ -681,7 +683,7 @@ paths: required: - vector_string - score - cvss_severities: &105 + cvss_severities: &107 type: object nullable: true properties: @@ -721,7 +723,7 @@ paths: required: - vector_string - score - epss: &106 + epss: &108 type: object nullable: true readOnly: true @@ -859,7 +861,7 @@ paths: - subscriptions_url - type - url - type: &373 + type: &385 type: string description: The type of credit the user is receiving. enum: @@ -992,7 +994,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &208 + schema: &218 title: Validation Error Simple description: Validation Error Simple type: object @@ -1025,7 +1027,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &703 + - &715 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1143,7 +1145,7 @@ paths: GitHub. type: object nullable: true - properties: &165 + properties: &169 id: description: Unique identifier of the GitHub app example: 37 @@ -1276,7 +1278,7 @@ paths: about itself. example: 5 type: integer - required: &166 + required: &170 - id - node_id - owner @@ -1581,7 +1583,7 @@ paths: schema: type: integer default: 30 - - &294 + - &304 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1597,7 +1599,7 @@ paths: application/json: schema: type: array - items: &295 + items: &305 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1677,7 +1679,7 @@ paths: - installation_id - repository_id examples: - default: &296 + default: &306 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1709,7 +1711,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &713 + schema: &725 title: Scim Error description: Scim Error type: object @@ -1736,7 +1738,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &207 + schema: &217 title: Validation Error description: Validation Error type: object @@ -1805,7 +1807,7 @@ paths: description: Response content: application/json: - schema: &297 + schema: &307 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1919,7 +1921,7 @@ paths: - request - response examples: - default: &298 + default: &308 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2120,7 +2122,7 @@ paths: parameters: - *17 - *19 - - &170 + - &174 name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2698,7 +2700,7 @@ paths: application/json: schema: *22 examples: - default: &74 + default: &76 value: id: 1 account: @@ -2848,11 +2850,11 @@ paths: - selected repositories: type: array - items: &64 + items: &66 title: Repository description: A repository on GitHub. type: object - properties: &353 + properties: &363 id: description: Unique identifier of the repository example: 42 @@ -2872,7 +2874,7 @@ paths: title: License Simple description: License Simple type: object - properties: &181 + properties: &185 key: type: string example: mit @@ -2894,7 +2896,7 @@ paths: html_url: type: string format: uri - required: &182 + required: &186 - key - name - url @@ -3290,7 +3292,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &354 + required: &364 - archive_url - assignees_url - blobs_url @@ -5077,7 +5079,7 @@ paths: responses: '202': *39 '422': *7 - '500': &88 + '500': &90 description: Internal Error content: application/json: @@ -7363,7 +7365,7 @@ paths: description: Response content: application/json: - schema: &209 + schema: &219 type: object properties: total_active_caches_count: @@ -7378,7 +7380,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &210 + default: &220 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7562,7 +7564,7 @@ paths: - public_ip_enabled - platform examples: - default: &211 + default: &221 value: total_count: 2 runners: @@ -7848,7 +7850,7 @@ paths: description: Response content: application/json: - schema: &212 + schema: &222 type: object properties: public_ips: @@ -7873,7 +7875,7 @@ paths: required: - public_ips examples: - default: &213 + default: &223 value: public_ips: current_usage: 17 @@ -7913,7 +7915,7 @@ paths: type: array items: *45 examples: - default: &214 + default: &224 value: id: 4-core cpu_cores: 4 @@ -8170,7 +8172,7 @@ paths: - all - local_only - selected - selected_actions_url: &217 + selected_actions_url: &227 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` @@ -8226,6 +8228,264 @@ paths: githubCloudOnly: true category: actions subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an enterprise + description: Gets artifact and log retention settings for an enterprise. + operationId: enterprise-admin/get-artifact-and-log-retention-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Successfully retrieved the artifact and log retention settings + content: + application/json: + schema: &201 + 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: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '401': &726 + description: Authorization failure + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an enterprise + description: Sets artifact and log retention settings for an enterprise. + operationId: enterprise-admin/set-artifact-and-log-retention-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise + parameters: + - *41 + responses: + '204': + description: Successfully updated the artifact and log retention settings + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: &202 + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + examples: + default: + summary: Set retention to 100 days + value: + days: 100 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an enterprise + description: Gets the fork PR contributor approval policy for an enterprise. + operationId: enterprise-admin/get-fork-pr-contributor-approval-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &50 + 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: &203 + value: + approval_policy: first_time_contributors + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an enterprise + description: Sets the fork PR contributor approval policy for an enterprise. + operationId: enterprise-admin/set-fork-pr-contributor-approval-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise + parameters: + - *41 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *50 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an enterprise + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an enterprise. + operationId: enterprise-admin/get-private-repo-fork-pr-workflows-settings + tags: + - enterprise-admin + 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-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &204 + 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: &51 + 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 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an enterprise + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an enterprise. + operationId: enterprise-admin/set-private-repo-fork-pr-workflows-settings + tags: + - enterprise-admin + 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-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: &205 + 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: *51 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions "/enterprises/{enterprise}/actions/permissions/organizations": get: summary: List selected organizations enabled for GitHub Actions in an enterprise @@ -8255,11 +8515,11 @@ paths: type: number organizations: type: array - items: &59 + items: &61 title: Organization Simple description: A GitHub organization. type: object - properties: &101 + properties: &103 login: type: string example: github @@ -8300,7 +8560,7 @@ paths: type: string example: A great organization nullable: true - required: &102 + required: &104 - login - url - id @@ -8317,7 +8577,7 @@ paths: - total_count - organizations examples: - default: &60 + default: &62 value: total_count: 1 organizations: @@ -8396,7 +8656,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - &50 + - &52 name: org_id description: The unique identifier of the organization. in: path @@ -8425,7 +8685,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - *50 + - *52 responses: '204': description: Response @@ -8454,7 +8714,7 @@ paths: description: Response content: application/json: - schema: &51 + schema: &53 type: object properties: github_owned_allowed: @@ -8475,7 +8735,7 @@ paths: items: type: string examples: - default: &52 + default: &54 value: github_owned_allowed: true verified_allowed: false @@ -8508,14 +8768,91 @@ paths: required: true content: application/json: - schema: *51 + schema: *53 examples: - selected_actions: *52 + selected_actions: *54 x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners permissions for an enterprise + description: Gets the settings for whether organizations in the enterprise are + allowed to manage self-hosted runners at the repository level. + operationId: enterprise-admin/get-self-hosted-runners-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + disable_self_hosted_runners_for_all_orgs: + type: boolean + description: When true, repository-level runners will be disabled + across all organizations in the enterprise + required: + - disable_self_hosted_runners_for_all_orgs + examples: + default: + value: + disable_self_hosted_runners_for_all_orgs: false + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners permissions for an enterprise + description: Sets the settings for whether organizations in the enterprise are + allowed to manage self-hosted runners at the repository level. + operationId: enterprise-admin/set-self-hosted-runners-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise + parameters: + - *41 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + disable_self_hosted_runners_for_all_orgs: + type: boolean + description: When true, repository-level runners will be disabled + across all organizations in the enterprise + required: + - disable_self_hosted_runners_for_all_orgs + examples: + default: + summary: Disable repository-level runners across all organizations + value: + disable_self_hosted_runners_for_all_orgs: true + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions "/enterprises/{enterprise}/actions/permissions/workflow": get: summary: Get default workflow permissions for an enterprise @@ -8538,17 +8875,17 @@ paths: description: Success response content: application/json: - schema: &220 + schema: &230 type: object properties: - default_workflow_permissions: &53 + default_workflow_permissions: &55 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &54 + can_approve_pull_request_reviews: &56 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -8556,7 +8893,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &55 + default: &57 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -8586,13 +8923,13 @@ paths: required: true content: application/json: - schema: &221 + schema: &231 type: object properties: - default_workflow_permissions: *53 - can_approve_pull_request_reviews: *54 + default_workflow_permissions: *55 + can_approve_pull_request_reviews: *56 examples: - default: *55 + default: *57 responses: '204': description: Success response @@ -8637,7 +8974,7 @@ paths: type: number runner_groups: type: array - items: &56 + items: &58 type: object properties: id: @@ -8816,9 +9153,9 @@ paths: description: Response content: application/json: - schema: *56 + schema: *58 examples: - default: &57 + default: &59 value: id: 2 name: octo-runner-group @@ -8853,7 +9190,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - &58 + - &60 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -8865,9 +9202,9 @@ paths: description: Response content: application/json: - schema: *56 + schema: *58 examples: - default: *57 + default: *59 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -8887,7 +9224,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - *58 + - *60 requestBody: required: false content: @@ -8939,7 +9276,7 @@ paths: description: Response content: application/json: - schema: *56 + schema: *58 examples: default: value: @@ -8975,7 +9312,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - *41 - - *58 + - *60 responses: '204': description: Response @@ -8999,7 +9336,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *58 + - *60 - *17 - *19 responses: @@ -9014,12 +9351,12 @@ paths: type: number organizations: type: array - items: *59 + items: *61 required: - total_count - organizations examples: - default: *60 + default: *62 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9039,7 +9376,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *58 + - *60 requestBody: required: true content: @@ -9085,8 +9422,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *58 - - *50 + - *60 + - *52 responses: '204': description: Response @@ -9109,8 +9446,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *58 - - *50 + - *60 + - *52 responses: '204': description: Response @@ -9134,7 +9471,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *58 + - *60 - *17 - *19 responses: @@ -9149,7 +9486,7 @@ paths: type: number runners: type: array - items: &62 + items: &64 title: Self hosted runners description: A self hosted runner type: object @@ -9178,7 +9515,7 @@ paths: type: boolean labels: type: array - items: &66 + items: &68 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -9211,7 +9548,7 @@ paths: - total_count - runners examples: - default: &63 + default: &65 value: total_count: 2 runners: @@ -9271,7 +9608,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *58 + - *60 requestBody: required: true content: @@ -9316,8 +9653,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - *41 - - *58 - - &61 + - *60 + - &63 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -9346,8 +9683,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - *41 - - *58 - - *61 + - *60 + - *63 responses: '204': description: Response @@ -9390,9 +9727,9 @@ paths: type: number runners: type: array - items: *62 + items: *64 examples: - default: *63 + default: *65 headers: Link: *40 x-github: @@ -9422,7 +9759,7 @@ paths: application/json: schema: type: array - items: &225 + items: &235 title: Runner Application description: Runner Application type: object @@ -9447,7 +9784,7 @@ paths: - download_url - filename examples: - default: &226 + default: &236 value: - os: osx architecture: x64 @@ -9531,7 +9868,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &227 + '201': &237 description: Response content: application/json: @@ -9541,7 +9878,7 @@ paths: - runner - encoded_jit_config properties: - runner: *62 + runner: *64 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -9570,7 +9907,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': &99 + '409': &101 description: Conflict content: application/json: @@ -9608,7 +9945,7 @@ paths: description: Response content: application/json: - schema: &65 + schema: &67 title: Authentication Token description: Authentication Token type: object @@ -9630,7 +9967,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *64 + items: *66 single_file: type: string example: config.yaml @@ -9646,7 +9983,7 @@ paths: - token - expires_at examples: - default: &228 + default: &238 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -9684,9 +10021,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *67 examples: - default: &229 + default: &239 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -9710,15 +10047,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 + - *63 responses: '200': description: Response content: application/json: - schema: *62 + schema: *64 examples: - default: &230 + default: &240 value: id: 23 name: MBP @@ -9758,7 +10095,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - *41 - - *61 + - *63 responses: '204': description: Response @@ -9783,9 +10120,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 + - *63 responses: - '200': &67 + '200': &69 description: Response content: application/json: @@ -9799,7 +10136,7 @@ paths: type: integer labels: type: array - items: *66 + items: *68 examples: default: value: @@ -9837,7 +10174,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 + - *63 requestBody: required: true content: @@ -9861,7 +10198,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -9884,7 +10221,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 + - *63 requestBody: required: true content: @@ -9909,7 +10246,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -9932,9 +10269,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 + - *63 responses: - '200': &231 + '200': &241 description: Response content: application/json: @@ -9948,7 +10285,7 @@ paths: type: integer labels: type: array - items: *66 + items: *68 examples: default: value: @@ -9989,8 +10326,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 - - &232 + - *63 + - &242 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9998,7 +10335,7 @@ paths: schema: type: string responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -10023,20 +10360,20 @@ paths: description: Response content: application/json: - schema: &72 + schema: &74 title: Announcement Banner description: Announcement at either the repository, organization, or enterprise level type: object properties: - announcement: &68 + announcement: &70 type: string description: The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." example: Very **important** announcement about _something_. nullable: true - expires_at: &69 + expires_at: &71 type: string format: date-time description: 'The time at which the announcement expires. This @@ -10046,7 +10383,7 @@ paths: it to an empty string.' example: '"2021-01-01T00:00:00.000-07:00"' nullable: true - user_dismissible: &70 + user_dismissible: &72 type: boolean description: Whether an announcement can be dismissed by the user. example: false @@ -10057,7 +10394,7 @@ paths: - expires_at - user_dismissible examples: - default: &71 + default: &73 summary: Announcement banner value: announcement: Very **important** announcement about _something_. @@ -10081,18 +10418,18 @@ paths: required: true content: application/json: - schema: &239 + schema: &249 title: Enterprise Announcement description: Enterprise global announcement type: object properties: - announcement: *68 - expires_at: *69 - user_dismissible: *70 + announcement: *70 + expires_at: *71 + user_dismissible: *72 required: - announcement examples: - default: *71 + default: *73 parameters: - *41 responses: @@ -10100,9 +10437,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *74 examples: - default: *71 + default: *73 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -10198,7 +10535,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - *41 - - &73 + - &75 name: org description: The organization name. The name is not case sensitive. in: path @@ -10215,7 +10552,7 @@ paths: application/json: schema: type: array - items: &75 + items: &77 title: Accessible Repository description: A repository that may be made accessible to a GitHub App. @@ -10266,7 +10603,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization parameters: - *41 - - *73 + - *75 - *17 - *19 responses: @@ -10361,7 +10698,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization parameters: - *41 - - *73 + - *75 responses: '200': description: A GitHub App installation that was installed previously. @@ -10369,14 +10706,14 @@ paths: application/json: schema: *22 examples: - default: *74 + default: *76 '201': description: A GitHub App installation. content: application/json: schema: *22 examples: - default: *74 + default: *76 requestBody: required: true content: @@ -10444,7 +10781,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization parameters: - *41 - - *73 + - *75 - *23 responses: '204': @@ -10472,7 +10809,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation parameters: - *41 - - *73 + - *75 - *23 - *17 - *19 @@ -10484,7 +10821,7 @@ paths: application/json: schema: type: array - items: *75 + items: *77 examples: default: value: @@ -10513,7 +10850,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories parameters: - *41 - - *73 + - *75 - *23 requestBody: required: true @@ -10553,7 +10890,7 @@ paths: application/json: schema: *22 examples: - default: *74 + default: *76 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -10574,7 +10911,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - *41 - - *73 + - *75 - *23 responses: '200': @@ -10584,7 +10921,7 @@ paths: application/json: schema: type: array - items: *75 + items: *77 examples: default: value: @@ -10635,7 +10972,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - *41 - - *73 + - *75 - *23 responses: '200': @@ -10645,7 +10982,7 @@ paths: application/json: schema: type: array - items: *75 + items: *77 examples: default: value: @@ -10722,7 +11059,7 @@ paths: required: false schema: type: string - - &240 + - &250 name: include description: |- The event types to include: @@ -10740,7 +11077,7 @@ paths: - web - git - all - - &241 + - &251 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. @@ -10748,7 +11085,7 @@ paths: required: false schema: type: string - - &242 + - &252 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. @@ -10756,7 +11093,7 @@ paths: required: false schema: type: string - - &243 + - &253 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -10778,7 +11115,7 @@ paths: application/json: schema: type: array - items: &244 + items: &254 type: object properties: "@timestamp": @@ -10900,7 +11237,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &245 + default: &255 value: - "@timestamp": 1606929874512 action: team.add_member @@ -11079,7 +11416,7 @@ paths: vendor_specific: type: object oneOf: - - &79 + - &81 title: AzureBlobConfig description: Azure Blob Config for audit log streaming configuration. type: object @@ -11093,7 +11430,7 @@ paths: required: - key_id - encrypted_sas_url - - &80 + - &82 title: AzureHubConfig description: Azure Event Hubs Config for audit log streaming configuration. type: object @@ -11112,7 +11449,7 @@ paths: - name - encrypted_connstring - key_id - - &81 + - &83 title: AmazonS3OIDCConfig description: Amazon S3 OIDC Config for audit log streaming configuration. type: object @@ -11140,7 +11477,7 @@ paths: - bucket - key_id - region - - &82 + - &84 title: AmazonS3AccessKeysConfig description: Amazon S3 Access Keys Config for audit log streaming configuration. @@ -11174,7 +11511,7 @@ paths: - encrypted_secret_key - key_id - region - - &83 + - &85 title: SplunkConfig description: Splunk Config for Audit Log Stream Configuration type: object @@ -11202,7 +11539,7 @@ paths: - key_id - port - ssl_verify - - &84 + - &86 title: HecConfig description: Hec Config for Audit Log Stream Configuration type: object @@ -11234,7 +11571,7 @@ paths: - key_id - port - ssl_verify - - &85 + - &87 title: GoogleCloudConfig description: Google Cloud Config for audit log streaming configuration. type: object @@ -11252,7 +11589,7 @@ paths: - bucket - key_id - encrypted_json_credentials - - &86 + - &88 title: DatadogConfig description: Datadog Config for audit log streaming configuration. type: object @@ -11283,7 +11620,7 @@ paths: - stream_type - vendor_specific examples: - default: &87 + default: &89 value: enabled: false stream_type: Azure Event Hubs @@ -11297,7 +11634,7 @@ paths: description: The audit log stream configuration was created successfully. content: application/json: - schema: &76 + schema: &78 title: Get an audit log streaming configuration description: Get an audit log streaming configuration for an enterprise. type: object @@ -11328,7 +11665,7 @@ paths: - created_at - updated_at examples: - default: &77 + default: &79 value: id: 1 stream_type: Splunk @@ -11357,7 +11694,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id parameters: - *41 - - &78 + - &80 name: stream_id description: The ID of the audit log stream configuration. in: path @@ -11369,9 +11706,9 @@ paths: description: Lists one audit log stream configuration via stream ID. content: application/json: - schema: *76 + schema: *78 examples: - default: *77 + default: *79 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -11391,7 +11728,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - *41 - - *78 + - *80 requestBody: required: true content: @@ -11417,28 +11754,28 @@ paths: vendor_specific: type: object oneOf: - - *79 - - *80 - *81 - *82 - *83 - *84 - *85 - *86 + - *87 + - *88 required: - enabled - stream_type - vendor_specific examples: - default: *87 + default: *89 responses: '200': description: Successful update content: application/json: - schema: *76 + schema: *78 examples: - default: *77 + default: *79 '422': description: Validation error content: @@ -11469,7 +11806,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise parameters: - *41 - - *78 + - *80 responses: '204': description: The audit log stream configuration was deleted successfully. @@ -11501,7 +11838,7 @@ paths: in: query schema: type: string - - &247 + - &257 name: reviewer description: Filter bypass requests by the handle of the GitHub user who reviewed the bypass request. @@ -11509,7 +11846,7 @@ paths: required: false schema: type: string - - &248 + - &258 name: requester description: Filter bypass requests by the handle of the GitHub user who requested the bypass. @@ -11517,7 +11854,7 @@ paths: required: false schema: type: string - - &249 + - &259 name: time_period description: |- The time period to filter by. @@ -11533,7 +11870,7 @@ paths: - week - month default: day - - &250 + - &260 name: request_status description: The status of the bypass request to filter on. When specified, only requests with this status will be returned. @@ -11560,7 +11897,7 @@ paths: application/json: schema: type: array - items: &251 + items: &261 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -11677,7 +12014,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: &254 + items: &264 title: Bypass response description: A response made by a delegated bypasser to a bypass request. @@ -11721,7 +12058,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &252 + default: &262 value: - id: 21 number: 42 @@ -11790,7 +12127,7 @@ paths: url: https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2 html_url: https://github.com/octo-org/smile/exemptions/2 '404': *6 - '500': *88 + '500': *90 "/enterprises/{enterprise}/code-scanning/alerts": get: summary: List code scanning alerts for an enterprise @@ -11808,17 +12145,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *41 - - &259 + - &269 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false - schema: &92 + schema: &94 type: string description: The name of the tool used to generate the code scanning analysis. - - &260 + - &270 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -11826,22 +12163,22 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &93 + schema: &95 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *89 - - *90 + - *91 + - *92 - *19 - *17 - - *91 + - *93 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &261 + schema: &271 type: string description: State of a code scanning alert. enum: @@ -11866,42 +12203,42 @@ paths: application/json: schema: type: array - items: &262 + items: &272 type: object properties: - number: &103 + number: &105 type: integer description: The security alert number. readOnly: true - created_at: &110 + created_at: &112 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &111 + updated_at: &113 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - url: &108 + url: &110 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &109 + html_url: &111 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &490 + instances_url: &502 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &94 + state: &96 type: string description: State of a code scanning alert. nullable: true @@ -11909,7 +12246,7 @@ paths: - open - dismissed - fixed - fixed_at: &113 + fixed_at: &115 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -11923,14 +12260,14 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: &112 + dismissed_at: &114 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissed_reason: &491 + dismissed_reason: &503 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -11939,13 +12276,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &492 + dismissed_comment: &504 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &493 + rule: &505 type: object properties: id: @@ -11998,25 +12335,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &494 + tool: &506 type: object properties: - name: *92 + name: *94 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *93 - most_recent_instance: &495 + guid: *95 + most_recent_instance: &507 type: object properties: - ref: &488 + ref: &500 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &505 + analysis_key: &517 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -12027,13 +12364,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &506 + category: &518 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *94 + state: *96 commit_sha: type: string message: @@ -12072,11 +12409,11 @@ paths: - generated - test - library - repository: &100 + repository: &102 title: Simple Repository description: A GitHub repository. type: object - properties: &197 + properties: &207 id: type: integer format: int64 @@ -12303,7 +12640,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &198 + required: &208 - archive_url - assignees_url - blobs_url @@ -12372,7 +12709,7 @@ paths: - most_recent_instance - repository examples: - default: &263 + default: &273 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -12603,7 +12940,7 @@ paths: headers: Link: *40 '404': *6 - '503': &157 + '503': &159 description: Service unavailable content: application/json: @@ -12647,8 +12984,8 @@ paths: schema: type: integer default: 30 - - *89 - - *90 + - *91 + - *92 responses: '200': description: Response @@ -12656,7 +12993,7 @@ paths: application/json: schema: type: array - items: &95 + items: &97 type: object description: A code security configuration properties: @@ -13025,7 +13362,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &264 + code_scanning_options: &274 type: object description: Security Configuration feature options for code scanning nullable: true @@ -13042,7 +13379,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &98 + code_scanning_default_setup_options: &100 type: object description: Feature options for code scanning default setup nullable: true @@ -13159,9 +13496,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *95 + schema: *97 examples: - default: &96 + default: &98 value: id: 1325 target_type: enterprise @@ -13219,7 +13556,7 @@ paths: description: Response content: application/json: - schema: &266 + schema: &276 type: array description: A list of default code security configurations items: @@ -13233,9 +13570,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *95 + configuration: *97 examples: - default: &267 + default: &277 value: - default_for_new_repos: public configuration: @@ -13324,7 +13661,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - *41 - - &97 + - &99 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -13336,9 +13673,9 @@ paths: description: Response content: application/json: - schema: *95 + schema: *97 examples: - default: *96 + default: *98 '304': *37 '403': *29 '404': *6 @@ -13363,7 +13700,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - *41 - - *97 + - *99 requestBody: required: true content: @@ -13442,7 +13779,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *98 + code_scanning_default_setup_options: *100 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -13530,13 +13867,13 @@ paths: description: Response content: application/json: - schema: *95 + schema: *97 examples: - default: *96 + default: *98 '304': *37 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13560,14 +13897,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - *41 - - *97 + - *99 responses: - '204': &123 + '204': &125 description: A header with no content is returned. '400': *14 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13592,7 +13929,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - *41 - - *97 + - *99 requestBody: required: true content: @@ -13619,7 +13956,7 @@ paths: '202': *39 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13644,7 +13981,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - *41 - - *97 + - *99 requestBody: required: true content: @@ -13684,12 +14021,12 @@ paths: - none - private_and_internal - public - configuration: *95 + configuration: *97 examples: default: value: default_for_new_repos: all - configuration: &265 + configuration: &275 value: id: 1325 target_type: organization @@ -13746,7 +14083,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - *41 - - *97 + - *99 - 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)." @@ -13755,8 +14092,8 @@ paths: schema: type: integer default: 30 - - *89 - - *90 + - *91 + - *92 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -13774,7 +14111,7 @@ paths: application/json: schema: type: array - items: &268 + items: &278 type: object description: Repositories associated with a code security configuration and attachment status @@ -13792,13 +14129,13 @@ paths: - failed - updating - removed_by_enterprise - repository: *100 + repository: *102 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: &269 + repository: &279 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -14227,7 +14564,7 @@ paths: For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -14263,7 +14600,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &114 + items: &116 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -14280,14 +14617,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *101 - required: *102 + properties: *103 + required: *104 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &255 + - &265 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -14346,7 +14683,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &331 + properties: &341 id: description: Unique identifier of the team type: integer @@ -14402,7 +14739,7 @@ paths: maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &332 + required: &342 - id - node_id - url @@ -14524,7 +14861,7 @@ paths: - created_at additionalProperties: false examples: - default: &115 + default: &117 value: total_seats: 2 seats: @@ -14593,7 +14930,7 @@ paths: site_admin: false headers: Link: *40 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -14655,7 +14992,7 @@ paths: application/json: schema: type: array - items: &161 + items: &165 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -14962,7 +15299,7 @@ paths: - date additionalProperties: true examples: - default: &162 + default: &166 value: - date: '2024-06-24' total_active_users: 24 @@ -15061,10 +15398,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *88 + '500': *90 '403': *29 '404': *6 - '422': &163 + '422': &167 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -15094,7 +15431,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *41 - - &276 + - &286 name: state in: query description: |- @@ -15103,7 +15440,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &277 + - &287 name: severity in: query description: |- @@ -15112,7 +15449,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &278 + - &288 name: ecosystem in: query description: |- @@ -15121,14 +15458,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &279 + - &289 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &280 + - &290 name: epss_percentage in: query description: |- @@ -15140,7 +15477,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &281 + - &291 name: has in: query description: |- @@ -15154,7 +15491,7 @@ paths: type: string enum: - patch - - &282 + - &292 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -15164,7 +15501,7 @@ paths: enum: - development - runtime - - &283 + - &293 name: sort in: query description: |- @@ -15179,10 +15516,10 @@ paths: - updated - epss_percentage default: created + - *93 - *91 - - *89 - - *90 - - &284 + - *92 + - &294 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -15195,7 +15532,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &285 + - &295 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -15215,11 +15552,11 @@ paths: application/json: schema: type: array - items: &286 + items: &296 type: object description: A Dependabot alert. properties: - number: *103 + number: *105 state: type: string description: The state of the Dependabot alert. @@ -15234,7 +15571,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &104 + package: &106 type: object description: Details for the vulnerable package. readOnly: true @@ -15278,7 +15615,7 @@ paths: - unknown - direct - transitive - security_advisory: &547 + security_advisory: &559 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -15308,13 +15645,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &107 + items: &109 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *104 + package: *106 severity: type: string description: The severity of the vulnerability. @@ -15380,8 +15717,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *105 - epss: *106 + cvss_severities: *107 + epss: *108 cwes: type: array description: Details for the advisory pertaining to Common @@ -15480,12 +15817,12 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *107 - url: *108 - html_url: *109 - created_at: *110 - updated_at: *111 - dismissed_at: *112 + security_vulnerability: *109 + url: *110 + html_url: *111 + created_at: *112 + updated_at: *113 + dismissed_at: *114 dismissed_by: title: Simple User description: A GitHub user. @@ -15509,15 +15846,15 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *113 - auto_dismissed_at: &548 + fixed_at: *115 + auto_dismissed_at: &560 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - repository: *100 + repository: *102 required: - number - state @@ -15536,7 +15873,7 @@ paths: - repository additionalProperties: false examples: - default: &287 + default: &297 value: - number: 2 state: dismissed @@ -15953,7 +16290,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user parameters: - *41 - - &246 + - &256 name: username description: The handle for the GitHub user account. in: path @@ -15975,10 +16312,10 @@ paths: teams or multiple organizations are only counted once. seats: type: array - items: *114 + items: *116 examples: - default: *115 - '500': *88 + default: *117 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -16020,7 +16357,7 @@ paths: type: integer network_configurations: type: array - items: &116 + items: &118 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -16060,7 +16397,7 @@ paths: - name - created_on examples: - default: &384 + default: &396 value: total_count: 2 network_configurations: @@ -16138,9 +16475,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: &117 + default: &119 value: id: 123456789ABCDEF name: My network configuration @@ -16167,7 +16504,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - &118 + - &120 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -16179,9 +16516,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: *117 + default: *119 headers: Link: *40 x-github: @@ -16201,7 +16538,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - *118 + - *120 requestBody: required: true content: @@ -16240,9 +16577,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: *117 + default: *119 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -16260,7 +16597,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise parameters: - *41 - - *118 + - *120 responses: '204': description: Response @@ -16283,7 +16620,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &385 + - &397 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -16295,7 +16632,7 @@ paths: description: Response content: application/json: - schema: &386 + schema: &398 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -16329,7 +16666,7 @@ paths: - subnet_id - region examples: - default: &387 + default: &399 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -16364,7 +16701,7 @@ paths: application/json: schema: type: array - items: &119 + items: &121 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -16430,7 +16767,7 @@ paths: - property_name - value_type examples: - default: &120 + default: &122 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -16487,7 +16824,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *119 + items: *121 minItems: 1 maxItems: 100 required: @@ -16517,9 +16854,9 @@ paths: application/json: schema: type: array - items: *119 + items: *121 examples: - default: *120 + default: *122 '403': *29 '404': *6 x-github: @@ -16542,8 +16879,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - *41 - - *73 - - &121 + - *75 + - &123 name: custom_property_name description: The custom property name in: path @@ -16555,9 +16892,9 @@ paths: description: Response content: application/json: - schema: *119 + schema: *121 examples: - default: &122 + default: &124 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -16590,15 +16927,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - *41 - - *121 + - *123 responses: '200': description: Response content: application/json: - schema: *119 + schema: *121 examples: - default: *122 + default: *124 '403': *29 '404': *6 x-github: @@ -16620,12 +16957,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise parameters: - *41 - - *121 + - *123 requestBody: required: true content: application/json: - schema: &351 + schema: &361 title: Custom Property Set Payload description: Custom property set payload type: object @@ -16689,9 +17026,9 @@ paths: description: Response content: application/json: - schema: *119 + schema: *121 examples: - default: *122 + default: *124 '403': *29 '404': *6 x-github: @@ -16713,9 +17050,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - *41 - - *121 + - *123 responses: - '204': *123 + '204': *125 '403': *29 '404': *6 x-github: @@ -16755,7 +17092,7 @@ paths: - push - repository default: branch - enforcement: &130 + enforcement: &132 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights @@ -16768,7 +17105,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &131 + items: &133 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -16805,7 +17142,7 @@ paths: - always - pull_request default: always - conditions: &154 + conditions: &156 title: Enterprise ruleset conditions type: object description: Conditions for an enterprise ruleset. The conditions @@ -16819,7 +17156,7 @@ paths: description: Conditions to target organizations by name and all repositories allOf: - - &124 + - &126 title: Repository ruleset conditions for organization names type: object description: Parameters for an organization name condition @@ -16845,7 +17182,7 @@ paths: type: string required: - organization_name - - &127 + - &129 title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -16874,7 +17211,7 @@ paths: is prevented. required: - repository_name - - &126 + - &128 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name condition @@ -16902,8 +17239,8 @@ paths: description: Conditions to target organizations by name and repositories by property allOf: - - *124 - - &129 + - *126 + - &131 title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -16916,7 +17253,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &125 + items: &127 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a repository @@ -16947,16 +17284,16 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *125 + items: *127 required: - repository_property - - *126 + - *128 - type: object title: organization_id_and_repository_name description: Conditions to target organizations by id and all repositories allOf: - - &128 + - &130 title: Repository ruleset conditions for organization IDs type: object description: Parameters for an organization ID condition @@ -16973,25 +17310,25 @@ paths: type: integer required: - organization_id - - *127 - - *126 + - *129 + - *128 - type: object title: organization_id_and_repository_property description: Conditions to target organization by id and repositories by property allOf: + - *130 + - *131 - *128 - - *129 - - *126 rules: type: array description: An array of rules within the ruleset. - items: &155 + items: &157 title: Repository Rule type: object description: A repository rule. oneOf: - - &132 + - &134 title: creation description: Only allow users with bypass permission to create matching refs. @@ -17003,7 +17340,7 @@ paths: type: string enum: - creation - - &133 + - &135 title: update description: Only allow users with bypass permission to update matching refs. @@ -17024,7 +17361,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &134 + - &136 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -17036,7 +17373,7 @@ paths: type: string enum: - deletion - - &135 + - &137 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -17048,7 +17385,7 @@ paths: type: string enum: - required_linear_history - - &136 + - &138 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches @@ -17072,7 +17409,7 @@ paths: type: string required: - required_deployment_environments - - &137 + - &139 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -17084,7 +17421,7 @@ paths: type: string enum: - required_signatures - - &138 + - &140 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -17144,7 +17481,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &139 + - &141 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed @@ -17191,7 +17528,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &140 + - &142 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -17203,7 +17540,7 @@ paths: type: string enum: - non_fast_forward - - &141 + - &143 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -17239,7 +17576,7 @@ paths: required: - operator - pattern - - &142 + - &144 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -17275,7 +17612,7 @@ paths: required: - operator - pattern - - &143 + - &145 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -17311,7 +17648,7 @@ paths: required: - operator - pattern - - &144 + - &146 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -17347,7 +17684,7 @@ paths: required: - operator - pattern - - &145 + - &147 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -17383,7 +17720,7 @@ paths: required: - operator - pattern - - &146 + - &148 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. @@ -17407,7 +17744,7 @@ paths: type: string required: - restricted_file_paths - - &147 + - &149 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit @@ -17431,7 +17768,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &148 + - &150 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -17454,7 +17791,7 @@ paths: type: string required: - restricted_file_extensions - - &149 + - &151 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. @@ -17478,7 +17815,7 @@ paths: maximum: 100 required: - max_file_size - - &150 + - &152 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -17527,7 +17864,7 @@ paths: - repository_id required: - workflows - - &151 + - &153 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning @@ -17613,7 +17950,7 @@ paths: description: Response content: application/json: - schema: &152 + schema: &154 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -17648,11 +17985,11 @@ paths: source: type: string description: The name of the source - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 + items: *133 current_user_can_bypass: type: string description: |- @@ -17683,8 +18020,8 @@ paths: conditions: nullable: true anyOf: - - *126 - - &358 + - *128 + - &368 title: Organization ruleset conditions type: object description: |- @@ -17698,14 +18035,14 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *126 - - *127 + - *128 + - *129 - type: object title: repository_id_and_ref_name description: Conditions to target repositories by id and refs by name allOf: - - *126 + - *128 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -17727,20 +18064,20 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *126 - - *129 + - *128 + - *131 rules: type: array - items: &669 + items: &681 title: Repository Rule type: object description: A repository rule. oneOf: - - *132 - - *133 - *134 - *135 - - &667 + - *136 + - *137 + - &679 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -17818,8 +18155,6 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - *136 - - *137 - *138 - *139 - *140 @@ -17834,6 +18169,8 @@ paths: - *149 - *150 - *151 + - *152 + - *153 created_at: type: string format: date-time @@ -17841,7 +18178,7 @@ paths: type: string format: date-time examples: - default: &153 + default: &155 value: id: 21 name: super cool ruleset @@ -17867,7 +18204,7 @@ paths: created_at: '2024-08-15T08:43:03Z' updated_at: '2024-09-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -17900,11 +18237,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *153 + default: *155 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -17946,16 +18283,16 @@ paths: - tag - push - repository - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 - conditions: *154 + items: *133 + conditions: *156 rules: description: An array of rules within the ruleset. type: array - items: *155 + items: *157 examples: default: value: @@ -17979,11 +18316,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *153 + default: *155 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -18010,7 +18347,7 @@ paths: '204': description: Response '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -18043,7 +18380,7 @@ paths: application/json: schema: type: array - items: &156 + items: &158 title: Ruleset version type: object description: The historical version of a ruleset @@ -18067,7 +18404,7 @@ paths: type: string format: date-time examples: - default: &361 + default: &371 value: - version_id: 3 actor: @@ -18085,7 +18422,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18120,9 +18457,9 @@ paths: description: Response content: application/json: - schema: &362 + schema: &372 allOf: - - *156 + - *158 - type: object required: - state @@ -18155,7 +18492,7 @@ paths: rules: - type: repository_delete '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18175,7 +18512,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *41 - - &363 + - &373 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -18186,7 +18523,7 @@ paths: enum: - open - resolved - - &364 + - &374 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -18196,7 +18533,7 @@ paths: required: false schema: type: string - - &365 + - &375 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -18205,7 +18542,7 @@ paths: required: false schema: type: string - - &366 + - &376 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -18217,11 +18554,11 @@ paths: - created - updated default: created - - *91 + - *93 - *17 - - *89 - - *90 - - &367 + - *91 + - *92 + - &377 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -18230,7 +18567,7 @@ paths: required: false schema: type: string - - &368 + - &378 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -18239,7 +18576,7 @@ paths: schema: type: boolean default: false - - &369 + - &379 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -18248,7 +18585,7 @@ paths: schema: type: boolean default: false - - &370 + - &380 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -18264,11 +18601,11 @@ paths: application/json: schema: type: array - items: &371 + items: &381 type: object properties: - number: *103 - created_at: *110 + number: *105 + created_at: *112 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -18276,21 +18613,21 @@ paths: format: date-time readOnly: true nullable: true - url: *108 - html_url: *109 + url: *110 + html_url: *111 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &681 + state: &693 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &682 + resolution: &694 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -18324,7 +18661,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *100 + repository: *102 push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected @@ -18397,8 +18734,8 @@ paths: pull request. ' - oneOf: &683 - - &685 + oneOf: &695 + - &697 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -18450,7 +18787,7 @@ paths: - blob_url - commit_sha - commit_url - - &686 + - &698 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -18505,7 +18842,7 @@ paths: - page_url - commit_sha - commit_url - - &687 + - &699 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -18519,7 +18856,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &688 + - &700 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -18533,7 +18870,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &689 + - &701 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -18547,7 +18884,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &690 + - &702 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -18561,7 +18898,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &691 + - &703 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -18575,7 +18912,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &692 + - &704 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -18589,7 +18926,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &693 + - &705 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -18603,7 +18940,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &694 + - &706 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -18617,7 +18954,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &695 + - &707 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -18631,7 +18968,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &696 + - &708 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -18645,7 +18982,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &697 + - &709 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -18665,7 +19002,7 @@ paths: description: A boolean value representing whether or not the token in the alert was detected in more than one location. examples: - default: &372 + default: &382 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -18916,12 +19253,239 @@ paths: headers: Link: *40 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/secret-scanning/pattern-configurations": + get: + summary: List enterprise pattern configurations + description: |- + Lists the secret scanning pattern configurations for an enterprise. + + Personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-enterprise-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &383 + title: Secret scanning pattern configuration + description: A collection of secret scanning patterns and their settings + related to push protection. + type: object + properties: + pattern_config_version: &161 + type: string + description: The version of the entity. This is used to confirm + you're updating the current version of the entity and mitigate + unintentionally overriding someone else's update. + nullable: true + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: &160 + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: string + description: The version of this pattern if it's a custom + pattern. + nullable: true + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this + pattern. + alert_total_percentage: + type: integer + description: The percentage of all alerts that this pattern + represents, rounded to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated + by this pattern. + false_positive_rate: + type: integer + description: The percentage of alerts from this pattern + that are false positives, rounded to the nearest integer. + bypass_rate: + type: integer + description: The percentage of blocks for this pattern that + were bypassed, rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this + pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: string + description: The push protection setting for this pattern + set at the enterprise level. Only present for partner + patterns when the organization has a parent enterprise. + enum: + - not-set + - disabled + - enabled + nullable: true + setting: + type: string + description: The current push protection setting for this + pattern. If this is `not-set`, then it inherits either + the enterprise setting if it exists or the default setting. + enum: + - not-set + - disabled + - enabled + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: *160 + examples: + default: &384 + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled + '403': *29 + '404': *6 + patch: + summary: Update enterprise pattern configurations + description: |- + Updates the secret scanning pattern configurations for an enterprise. + + Personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-enterprise-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: *161 + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: *161 + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': *14 + '403': *29 + '404': *6 + '409': *101 + '422': *15 "/enterprises/{enterprise}/settings/billing/actions": get: summary: Get GitHub Actions billing for an enterprise @@ -18947,7 +19511,7 @@ paths: description: Response content: application/json: - schema: &375 + schema: &387 type: object properties: total_minutes_used: @@ -19017,7 +19581,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &376 + default: &388 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -19048,7 +19612,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &377 + - &389 name: advanced_security_product in: query description: | @@ -19068,7 +19632,7 @@ paths: description: Success content: application/json: - schema: &378 + schema: &390 type: object properties: total_advanced_security_committers: @@ -19123,7 +19687,7 @@ paths: required: - repositories examples: - default: &379 + default: &391 value: total_advanced_security_committers: 2 total_count: 2 @@ -19219,8 +19783,8 @@ paths: name: octocat/hello-world '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19338,7 +19902,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - *41 - - &160 + - &164 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -19350,7 +19914,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &158 + schema: &162 type: object properties: id: @@ -19378,7 +19942,7 @@ paths: - name - resources examples: - default: &159 + default: &163 value: - id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -19389,8 +19953,8 @@ paths: name: octocat/hello-world '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19440,15 +20004,15 @@ paths: description: Response when updating a cost center content: application/json: - schema: *158 + schema: *162 examples: - default: *159 + default: *163 '400': *14 '403': *29 '404': *6 - '409': *99 - '500': *88 - '503': *157 + '409': *101 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19466,7 +20030,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - *41 - - *160 + - *164 responses: '200': description: Response when deleting a cost center @@ -19504,8 +20068,8 @@ paths: '400': *14 '404': *6 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19526,7 +20090,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - *41 - - *160 + - *164 requestBody: required: true content: @@ -19571,9 +20135,9 @@ paths: message: Resources successfully added to the cost center. '400': *14 '403': *29 - '409': *99 - '500': *88 - '503': *157 + '409': *101 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19593,7 +20157,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - *41 - - *160 + - *164 requestBody: required: true content: @@ -19639,8 +20203,8 @@ paths: message: Resources successfully removed from the cost center. '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19671,7 +20235,7 @@ paths: description: Response content: application/json: - schema: &380 + schema: &392 type: object properties: total_gigabytes_bandwidth_used: @@ -19689,7 +20253,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &381 + default: &393 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -19724,7 +20288,7 @@ paths: description: Response content: application/json: - schema: &382 + schema: &394 type: object properties: days_left_in_billing_cycle: @@ -19742,7 +20306,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &383 + default: &395 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -19767,7 +20331,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *41 - - &199 + - &209 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, @@ -19776,7 +20340,7 @@ paths: required: false schema: type: integer - - &200 + - &210 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 @@ -19785,7 +20349,7 @@ paths: required: false schema: type: integer - - &201 + - &211 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 @@ -19794,7 +20358,7 @@ paths: required: false schema: type: integer - - &202 + - &212 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 @@ -19815,7 +20379,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &203 + schema: &213 type: object properties: usageItems: @@ -19868,7 +20432,7 @@ paths: - netAmount - organizationName examples: - default: &204 + default: &214 value: usageItems: - date: '2023-08-01' @@ -19884,8 +20448,8 @@ paths: repositoryName: github/example '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19956,13 +20520,13 @@ paths: application/json: schema: type: array - items: *161 + items: *165 examples: - default: *162 - '500': *88 + default: *166 + '500': *90 '403': *29 '404': *6 - '422': *163 + '422': *167 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -20051,7 +20615,7 @@ paths: application/json: schema: type: array - items: &192 + items: &196 title: Event description: Event type: object @@ -20061,7 +20625,7 @@ paths: type: type: string nullable: true - actor: &164 + actor: &168 title: Actor description: Actor type: object @@ -20101,18 +20665,18 @@ paths: - id - name - url - org: *164 + org: *168 payload: type: object properties: action: type: string - issue: &180 + issue: &184 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &605 + properties: &617 id: type: integer format: int64 @@ -20224,7 +20788,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &532 + properties: &544 url: type: string format: uri @@ -20294,7 +20858,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &533 + required: &545 - closed_issues - creator - description @@ -20373,7 +20937,7 @@ paths: timeline_url: type: string format: uri - type: &316 + type: &326 title: Issue Type description: The type of issue. type: object @@ -20422,7 +20986,7 @@ paths: - node_id - name - description - repository: *64 + repository: *66 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -20432,9 +20996,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 - author_association: &167 + properties: *169 + required: *170 + author_association: &171 title: author_association type: string example: OWNER @@ -20448,7 +21012,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &168 + reactions: &172 title: Reaction Rollup type: object properties: @@ -20484,7 +21048,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &741 + sub_issues_summary: &753 title: Sub-issues Summary type: object properties: @@ -20498,7 +21062,24 @@ paths: - total - completed - percent_completed - required: &606 + issue_dependencies_summary: &754 + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + required: &618 - assignee - closed_at - comments @@ -20520,7 +21101,7 @@ paths: - author_association - created_at - updated_at - comment: &603 + comment: &615 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -20568,7 +21149,7 @@ paths: issue_url: type: string format: uri - author_association: *167 + author_association: *171 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -20578,9 +21159,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 - reactions: *168 + properties: *169 + required: *170 + reactions: *172 required: - id - node_id @@ -20675,7 +21256,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20756,7 +21337,7 @@ paths: _links: type: object properties: - timeline: &169 + timeline: &173 title: Link With Type description: Hypermedia Link with Type type: object @@ -20768,17 +21349,17 @@ paths: required: - href - type - user: *169 - security_advisories: *169 - current_user: *169 - current_user_public: *169 - current_user_actor: *169 - current_user_organization: *169 + user: *173 + security_advisories: *173 + current_user: *173 + current_user_public: *173 + current_user_actor: *173 + current_user_organization: *173 current_user_organizations: type: array - items: *169 - repository_discussions: *169 - repository_discussions_category: *169 + items: *173 + repository_discussions: *173 + repository_discussions_category: *173 required: - timeline - user @@ -20840,7 +21421,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *170 + - *174 - *17 - *19 responses: @@ -20850,7 +21431,7 @@ paths: application/json: schema: type: array - items: &171 + items: &175 title: Base Gist description: Base Gist type: object @@ -20949,7 +21530,7 @@ paths: - created_at - updated_at examples: - default: &172 + default: &176 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -21070,7 +21651,7 @@ paths: description: Response content: application/json: - schema: &173 + schema: &177 title: Gist Simple description: Gist Simple type: object @@ -21087,7 +21668,7 @@ paths: url: type: string format: uri - user: &753 + user: &766 title: Public User description: Public User type: object @@ -21449,7 +22030,7 @@ paths: truncated: type: boolean examples: - default: &174 + default: &178 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -21553,7 +22134,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *170 + - *174 - *17 - *19 responses: @@ -21563,9 +22144,9 @@ paths: application/json: schema: type: array - items: *171 + items: *175 examples: - default: *172 + default: *176 headers: Link: *40 '422': *15 @@ -21587,7 +22168,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *170 + - *174 - *17 - *19 responses: @@ -21597,9 +22178,9 @@ paths: application/json: schema: type: array - items: *171 + items: *175 examples: - default: *172 + default: *176 headers: Link: *40 '401': *25 @@ -21627,7 +22208,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &175 + - &179 name: gist_id description: The unique identifier of the gist. in: path @@ -21639,10 +22220,10 @@ paths: description: Response content: application/json: - schema: *173 + schema: *177 examples: - default: *174 - '403': &178 + default: *178 + '403': &182 description: Forbidden Gist content: application/json: @@ -21690,7 +22271,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *175 + - *179 requestBody: required: true content: @@ -21750,9 +22331,9 @@ paths: description: Response content: application/json: - schema: *173 + schema: *177 examples: - updateGist: *174 + updateGist: *178 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -21910,7 +22491,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *175 + - *179 responses: '204': description: Response @@ -21939,7 +22520,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *175 + - *179 - *17 - *19 responses: @@ -21949,7 +22530,7 @@ paths: application/json: schema: type: array - items: &176 + items: &180 title: Gist Comment description: A comment made to a gist. type: object @@ -21984,7 +22565,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *167 + author_association: *171 required: - url - id @@ -22049,7 +22630,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *175 + - *179 requestBody: required: true content: @@ -22074,9 +22655,9 @@ paths: description: Response content: application/json: - schema: *176 + schema: *180 examples: - default: &177 + default: &181 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -22134,8 +22715,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *175 - - &179 + - *179 + - &183 name: comment_id description: The unique identifier of the comment. in: path @@ -22148,12 +22729,12 @@ paths: description: Response content: application/json: - schema: *176 + schema: *180 examples: - default: *177 + default: *181 '304': *37 '404': *6 - '403': *178 + '403': *182 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22175,8 +22756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *175 - *179 + - *183 requestBody: required: true content: @@ -22201,9 +22782,9 @@ paths: description: Response content: application/json: - schema: *176 + schema: *180 examples: - default: *177 + default: *181 '404': *6 x-github: githubCloudOnly: false @@ -22220,8 +22801,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *175 - *179 + - *183 responses: '204': description: Response @@ -22244,7 +22825,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *175 + - *179 - *17 - *19 responses: @@ -22345,7 +22926,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *175 + - *179 - *17 - *19 responses: @@ -22355,7 +22936,7 @@ paths: application/json: schema: type: array - items: *173 + items: *177 examples: default: value: @@ -22420,13 +23001,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *175 + - *179 responses: '201': description: Response content: application/json: - schema: *171 + schema: *175 examples: default: value: @@ -22497,7 +23078,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *175 + - *179 responses: '204': description: Response if gist is starred @@ -22527,7 +23108,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *175 + - *179 responses: '204': description: Response @@ -22549,7 +23130,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *175 + - *179 responses: '204': description: Response @@ -22578,7 +23159,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *175 + - *179 - name: sha in: path required: true @@ -22589,9 +23170,9 @@ paths: description: Response content: application/json: - schema: *173 + schema: *177 examples: - default: *174 + default: *178 '422': *15 '404': *6 '403': *29 @@ -22750,7 +23331,7 @@ paths: type: integer repositories: type: array - items: *64 + items: *66 repository_selection: type: string example: selected @@ -22957,7 +23538,7 @@ paths: - closed - all default: open - - &319 + - &329 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -22975,8 +23556,8 @@ paths: - updated - comments default: created - - *91 - - *170 + - *93 + - *174 - name: collab in: query required: false @@ -23006,9 +23587,9 @@ paths: application/json: schema: type: array - items: *180 + items: *184 examples: - default: &320 + default: &330 value: - id: 1 node_id: MDU6SXNzdWUx @@ -23292,8 +23873,8 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 examples: default: value: @@ -23578,7 +24159,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &183 + X-CommonMarker-Version: &187 example: 0.17.4 schema: type: string @@ -23633,7 +24214,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *183 + X-CommonMarker-Version: *187 content: text/html: schema: @@ -23662,7 +24243,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &186 + - &190 name: account_id description: account_id parameter in: path @@ -23674,7 +24255,7 @@ paths: description: Response content: application/json: - schema: &185 + schema: &189 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -23704,7 +24285,7 @@ paths: nullable: true id: type: integer - plan: &184 + plan: &188 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -23793,7 +24374,7 @@ paths: nullable: true updated_at: type: string - plan: *184 + plan: *188 required: - url - id @@ -23801,7 +24382,7 @@ paths: - login - marketplace_purchase examples: - default: &187 + default: &191 value: url: https://api.github.com/orgs/github type: Organization @@ -23886,9 +24467,9 @@ paths: application/json: schema: type: array - items: *184 + items: *188 examples: - default: &188 + default: &192 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -23928,14 +24509,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &189 + - &193 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &190 + - &194 name: sort description: The property to sort the results by. in: query @@ -23965,9 +24546,9 @@ paths: application/json: schema: type: array - items: *185 + items: *189 examples: - default: &191 + default: &195 value: - url: https://api.github.com/orgs/github type: Organization @@ -24041,15 +24622,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *186 + - *190 responses: '200': description: Response content: application/json: - schema: *185 + schema: *189 examples: - default: *187 + default: *191 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -24081,9 +24662,9 @@ paths: application/json: schema: type: array - items: *184 + items: *188 examples: - default: *188 + default: *192 headers: Link: *40 '401': *25 @@ -24106,8 +24687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *189 - - *190 + - *193 + - *194 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -24127,9 +24708,9 @@ paths: application/json: schema: type: array - items: *185 + items: *189 examples: - default: *191 + default: *195 headers: Link: *40 '401': *25 @@ -24393,14 +24974,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &407 + - &419 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &408 + - &420 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -24417,7 +24998,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -24471,7 +25052,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &421 + '301': &433 description: Moved permanently content: application/json: @@ -24493,7 +25074,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &635 + - &647 name: all description: If `true`, show notifications marked as read. in: query @@ -24501,7 +25082,7 @@ paths: schema: type: boolean default: false - - &636 + - &648 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -24510,8 +25091,8 @@ paths: schema: type: boolean default: false - - *170 - - &637 + - *174 + - &649 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -24536,18 +25117,18 @@ paths: application/json: schema: type: array - items: &193 + items: &197 title: Thread description: Thread type: object properties: id: type: string - repository: &224 + repository: &234 title: Minimal Repository description: Minimal Repository type: object - properties: &289 + properties: &299 id: type: integer format: int64 @@ -24823,7 +25404,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &355 + security_and_analysis: &365 nullable: true type: object properties: @@ -24905,7 +25486,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &290 + required: &300 - archive_url - assignees_url - blobs_url @@ -24993,7 +25574,7 @@ paths: - url - subscription_url examples: - default: &638 + default: &650 value: - id: '1' repository: @@ -25159,7 +25740,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &194 + - &198 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -25173,7 +25754,7 @@ paths: description: Response content: application/json: - schema: *193 + schema: *197 examples: default: value: @@ -25276,7 +25857,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *194 + - *198 responses: '205': description: Reset Content @@ -25299,7 +25880,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *194 + - *198 responses: '204': description: No content @@ -25322,13 +25903,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *194 + - *198 responses: '200': description: Response content: application/json: - schema: &195 + schema: &199 title: Thread Subscription description: Thread Subscription type: object @@ -25365,7 +25946,7 @@ paths: - url - subscribed examples: - default: &196 + default: &200 value: subscribed: true ignored: false @@ -25396,7 +25977,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *194 + - *198 requestBody: required: false content: @@ -25417,9 +25998,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '304': *37 '403': *29 '401': *25 @@ -25442,7 +26023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *194 + - *198 responses: '204': description: Response @@ -25537,9 +26118,9 @@ paths: application/json: schema: type: array - items: *59 + items: *61 examples: - default: &771 + default: &783 value: - login: github id: 1 @@ -25603,7 +26184,7 @@ paths: type: integer custom_roles: type: array - items: &271 + items: &281 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -25651,7 +26232,7 @@ paths: - created_at - updated_at examples: - default: &272 + default: &282 value: id: 8030 name: Security Engineer @@ -25683,6 +26264,555 @@ 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: + - *75 + responses: + '200': + description: Response + content: + application/json: + schema: *201 + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': *29 + '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: + - *75 + requestBody: + required: true + content: + application/json: + schema: *202 + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': *29 + '404': *6 + '409': *101 + '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: + - *75 + responses: + '200': + description: Response + content: + application/json: + schema: *50 + examples: + default: *203 + '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: + - *75 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *50 + 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: + - *75 + responses: + '200': + description: Response + content: + application/json: + schema: *204 + examples: + default: *51 + '403': *29 + '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: + - *75 + requestBody: + required: true + content: + application/json: + schema: *205 + examples: + default: *51 + 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: + - *75 + 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': *29 + '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: + - *75 + 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': *29 + '404': *6 + '409': *101 + '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: + - *75 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: *66 + examples: + default: &229 + 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': *29 + '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: + - *75 + 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': *29 + '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: + - *75 + - &206 + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + responses: + '204': + description: No content + '403': *29 + '404': *6 + '409': *101 + '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: + - *75 + - *206 + responses: + '204': + description: No content + '403': *29 + '404': *6 + '409': *101 + '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 @@ -25698,7 +26828,7 @@ paths: 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 parameters: - - *73 + - *75 - name: page in: query description: The page number of results to fetch. @@ -25742,8 +26872,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *197 - required: *198 + properties: *207 + required: *208 nullable: true additionalProperties: false examples: @@ -25849,7 +26979,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -25915,7 +27045,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *73 + - *75 requestBody: required: true content: @@ -25962,23 +27092,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - *73 - - *199 - - *200 - - *201 - - *202 + - *75 + - *209 + - *210 + - *211 + - *212 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *203 + schema: *213 examples: - default: *204 + default: *214 '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26004,13 +27134,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: &205 + schema: &215 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -26343,7 +27473,7 @@ paths: - updated_at - archived_at examples: - default-response: &206 + default-response: &216 value: login: github id: 1 @@ -26445,7 +27575,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *73 + - *75 requestBody: required: false content: @@ -26668,18 +27798,18 @@ paths: description: Response content: application/json: - schema: *205 + schema: *215 examples: - default: *206 + default: *216 '422': description: Validation failed content: application/json: schema: oneOf: - - *207 - - *208 - '409': *99 + - *217 + - *218 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26702,7 +27832,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *73 + - *75 responses: '202': *39 '404': *6 @@ -26727,15 +27857,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *209 + schema: *219 examples: - default: *210 + default: *220 headers: Link: *40 x-github: @@ -26758,7 +27888,7 @@ paths: 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: - - *73 + - *75 - *17 - *19 responses: @@ -26776,7 +27906,7 @@ paths: type: integer repository_cache_usages: type: array - items: &426 + items: &438 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -26831,7 +27961,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *73 + - *75 - *17 - *19 responses: @@ -26851,7 +27981,7 @@ paths: type: array items: *42 examples: - default: *211 + default: *221 headers: Link: *40 x-github: @@ -26871,7 +28001,7 @@ paths: 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: - - *73 + - *75 requestBody: required: true content: @@ -26958,7 +28088,7 @@ paths: 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: - - *73 + - *75 responses: '200': description: Response @@ -26994,7 +28124,7 @@ paths: 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: - - *73 + - *75 responses: '200': description: Response @@ -27029,15 +28159,15 @@ paths: 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 parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *212 + schema: *222 examples: - default: *213 + default: *223 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27055,7 +28185,7 @@ paths: 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: - - *73 + - *75 responses: '200': description: Response @@ -27073,7 +28203,7 @@ paths: type: array items: *45 examples: - default: *214 + default: *224 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27091,7 +28221,7 @@ paths: 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 parameters: - - *73 + - *75 responses: '200': description: Response @@ -27135,7 +28265,7 @@ paths: 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: - - *73 + - *75 - *47 responses: '200': @@ -27164,7 +28294,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *73 + - *75 - *47 requestBody: required: true @@ -27221,7 +28351,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *73 + - *75 - *47 responses: '202': @@ -27250,13 +28380,13 @@ paths: 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: - - *73 + - *75 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &215 + schema: &225 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -27270,7 +28400,7 @@ paths: required: - include_claim_keys examples: - default: &216 + default: &226 value: include_claim_keys: - repo @@ -27292,20 +28422,20 @@ paths: 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 parameters: - - *73 + - *75 requestBody: required: true content: application/json: - schema: *215 + schema: *225 examples: - default: *216 + default: *226 responses: '201': description: Empty response content: application/json: - schema: &235 + schema: &245 title: Empty Object description: An object without any properties. type: object @@ -27335,7 +28465,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -27344,7 +28474,7 @@ paths: schema: type: object properties: - enabled_repositories: &218 + enabled_repositories: &228 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -27358,7 +28488,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *49 - selected_actions_url: *217 + selected_actions_url: *227 required: - enabled_repositories examples: @@ -27387,7 +28517,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *73 + - *75 responses: '204': description: Response @@ -27398,7 +28528,7 @@ paths: schema: type: object properties: - enabled_repositories: *218 + enabled_repositories: *228 allowed_actions: *49 required: - enabled_repositories @@ -27426,7 +28556,7 @@ paths: 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 parameters: - - *73 + - *75 - *17 - *19 responses: @@ -27444,129 +28574,9 @@ paths: type: number repositories: type: array - items: *64 + items: *66 examples: - default: &765 - 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 + default: *229 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -27586,7 +28596,7 @@ paths: 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 parameters: - - *73 + - *75 responses: '204': description: Response @@ -27630,14 +28640,8 @@ paths: 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 parameters: - - *73 - - &219 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer + - *75 + - *206 responses: '204': description: Response @@ -27659,8 +28663,8 @@ paths: 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 parameters: - - *73 - - *219 + - *75 + - *206 responses: '204': description: Response @@ -27683,15 +28687,15 @@ paths: 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: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *51 + schema: *53 examples: - default: *52 + default: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -27714,7 +28718,7 @@ paths: 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: - - *73 + - *75 responses: '204': description: Response @@ -27722,9 +28726,9 @@ paths: required: false content: application/json: - schema: *51 + schema: *53 examples: - selected_actions: *52 + selected_actions: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -27746,15 +28750,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *220 + schema: *230 examples: - default: *55 + default: *57 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27775,7 +28779,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *73 + - *75 responses: '204': description: Success response @@ -27786,9 +28790,9 @@ paths: required: false content: application/json: - schema: *221 + schema: *231 examples: - default: *55 + default: *57 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27808,7 +28812,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *73 + - *75 - *17 - *19 - name: visible_to_repository @@ -27833,7 +28837,7 @@ paths: type: number runner_groups: type: array - items: &222 + items: &232 type: object properties: id: @@ -27949,7 +28953,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -28021,9 +29025,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *232 examples: - default: &223 + default: &233 value: id: 2 name: octo-runner-group @@ -28058,14 +29062,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *73 - - *58 + - *75 + - *60 responses: '200': description: Response content: application/json: - schema: *222 + schema: *232 examples: default: value: @@ -28101,8 +29105,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *73 - - *58 + - *75 + - *60 requestBody: required: true content: @@ -28156,9 +29160,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *232 examples: - default: *223 + default: *233 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -28177,8 +29181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *73 - - *58 + - *75 + - *60 responses: '204': description: Response @@ -28201,8 +29205,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *73 - - *58 + - *75 + - *60 - *17 - *19 responses: @@ -28222,7 +29226,7 @@ paths: type: array items: *42 examples: - default: *211 + default: *221 headers: Link: *40 x-github: @@ -28244,8 +29248,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *73 - - *58 + - *75 + - *60 - *19 - *17 responses: @@ -28263,9 +29267,9 @@ paths: type: number repositories: type: array - items: *224 + items: *234 examples: - default: &756 + default: &769 value: total_count: 1 repositories: @@ -28517,8 +29521,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *73 - - *58 + - *75 + - *60 requestBody: required: true content: @@ -28562,9 +29566,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *73 - - *58 - - *219 + - *75 + - *60 + - *206 responses: '204': description: Response @@ -28586,9 +29590,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *73 - - *58 - - *219 + - *75 + - *60 + - *206 responses: '204': description: Response @@ -28611,8 +29615,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *73 - - *58 + - *75 + - *60 - *17 - *19 responses: @@ -28630,9 +29634,9 @@ paths: type: number runners: type: array - items: *62 + items: *64 examples: - default: *63 + default: *65 headers: Link: *40 x-github: @@ -28653,8 +29657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *73 - - *58 + - *75 + - *60 requestBody: required: true content: @@ -28698,9 +29702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *73 - - *58 - - *61 + - *75 + - *60 + - *63 responses: '204': description: Response @@ -28722,9 +29726,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *73 - - *58 - - *61 + - *75 + - *60 + - *63 responses: '204': description: Response @@ -28754,7 +29758,7 @@ paths: in: query schema: type: string - - *73 + - *75 - *17 - *19 responses: @@ -28772,9 +29776,9 @@ paths: type: integer runners: type: array - items: *62 + items: *64 examples: - default: *63 + default: *65 headers: Link: *40 x-github: @@ -28798,7 +29802,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -28806,9 +29810,9 @@ paths: application/json: schema: type: array - items: *225 + items: *235 examples: - default: *226 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28830,7 +29834,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -28873,10 +29877,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *227 + '201': *237 '404': *6 '422': *7 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28904,15 +29908,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *73 + - *75 responses: '201': description: Response content: application/json: - schema: *65 + schema: *67 examples: - default: *228 + default: *238 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28940,15 +29944,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *73 + - *75 responses: '201': description: Response content: application/json: - schema: *65 + schema: *67 examples: - default: *229 + default: *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28970,16 +29974,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 + - *75 + - *63 responses: '200': description: Response content: application/json: - schema: *62 + schema: *64 examples: - default: *230 + default: *240 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29000,8 +30004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *73 - - *61 + - *75 + - *63 responses: '204': description: Response @@ -29027,10 +30031,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 + - *75 + - *63 responses: - '200': *67 + '200': *69 '404': *6 x-github: githubCloudOnly: false @@ -29052,8 +30056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 + - *75 + - *63 requestBody: required: true content: @@ -29077,7 +30081,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -29101,8 +30105,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 + - *75 + - *63 requestBody: required: true content: @@ -29127,7 +30131,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -29151,10 +30155,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 + - *75 + - *63 responses: - '200': *231 + '200': *241 '404': *6 x-github: githubCloudOnly: false @@ -29181,11 +30185,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 - - *232 + - *75 + - *63 + - *242 responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -29210,7 +30214,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *73 + - *75 - *17 - *19 responses: @@ -29228,7 +30232,7 @@ paths: type: integer secrets: type: array - items: &233 + items: &243 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -29301,13 +30305,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: &446 + schema: &458 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -29336,7 +30340,7 @@ paths: - key_id - key examples: - default: &447 + default: &459 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29361,8 +30365,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *73 - - &234 + - *75 + - &244 name: secret_name description: The name of the secret. in: path @@ -29374,7 +30378,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *243 examples: default: value: @@ -29404,8 +30408,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -29462,7 +30466,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -29488,8 +30492,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 responses: '204': description: Response @@ -29515,8 +30519,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - *19 - *17 responses: @@ -29534,9 +30538,9 @@ paths: type: integer repositories: type: array - items: *224 + items: *234 examples: - default: &238 + default: &248 value: total_count: 1 repositories: @@ -29628,8 +30632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -29681,8 +30685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -29715,8 +30719,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -29748,8 +30752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *73 - - &431 + - *75 + - &443 name: per_page description: The number of results per page (max 30). 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)." @@ -29773,7 +30777,7 @@ paths: type: integer variables: type: array - items: &236 + items: &246 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -29858,7 +30862,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *73 + - *75 requestBody: required: true content: @@ -29906,7 +30910,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -29931,8 +30935,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *73 - - &237 + - *75 + - &247 name: name description: The name of the variable. in: path @@ -29944,7 +30948,7 @@ paths: description: Response content: application/json: - schema: *236 + schema: *246 examples: default: value: @@ -29974,8 +30978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 requestBody: required: true content: @@ -30037,8 +31041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 responses: '204': description: Response @@ -30064,8 +31068,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 - *19 - *17 responses: @@ -30083,9 +31087,9 @@ paths: type: integer repositories: type: array - items: *224 + items: *234 examples: - default: *238 + default: *248 '409': description: Response when the visibility of the variable is not set to `selected` @@ -30111,8 +31115,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 requestBody: required: true content: @@ -30161,8 +31165,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 - name: repository_id in: path required: true @@ -30196,8 +31200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 - name: repository_id in: path required: true @@ -30228,15 +31232,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *72 + schema: *74 examples: - default: *71 + default: *73 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -30255,19 +31259,19 @@ paths: required: true content: application/json: - schema: *239 + schema: *249 examples: - default: *71 + default: *73 parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *72 + schema: *74 examples: - default: *71 + default: *73 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -30283,7 +31287,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *73 + - *75 responses: '204': description: Response @@ -30309,9 +31313,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations-by-bulk-subject-digests parameters: - *17 - - *89 - - *90 - - *73 + - *91 + - *92 + - *75 requestBody: required: true content: @@ -30334,12 +31338,12 @@ paths: required: - subject_digests examples: - default: &786 + default: &798 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &787 + withPredicateType: &799 value: subject_digests: - sha256:abc123 @@ -30397,7 +31401,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &788 + default: &800 value: attestations_subject_digests: - sha256:abc: @@ -30506,7 +31510,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *73 + - *75 requestBody: required: true content: @@ -30571,7 +31575,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *73 + - *75 - name: subject_digest description: Subject Digest in: path @@ -30602,7 +31606,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id parameters: - - *73 + - *75 - name: attestation_id description: Attestation ID in: path @@ -30638,9 +31642,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations parameters: - *17 - - *89 - - *90 - - *73 + - *91 + - *92 + - *75 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -30691,7 +31695,7 @@ paths: bundle_url: type: string examples: - default: &460 + default: &472 value: attestations: - bundle: @@ -30809,7 +31813,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - - *73 + - *75 - name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). @@ -30817,10 +31821,10 @@ paths: required: false schema: type: string - - *240 - - *241 - - *242 - - *243 + - *250 + - *251 + - *252 + - *253 - *17 responses: '200': @@ -30829,9 +31833,9 @@ paths: application/json: schema: type: array - items: *244 + items: *254 examples: - default: *245 + default: *255 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -30848,7 +31852,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *73 + - *75 - *17 - *19 responses: @@ -30860,7 +31864,7 @@ paths: type: array items: *4 examples: - default: &321 + default: &331 value: - login: octocat id: 1 @@ -30898,8 +31902,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: If the user is blocked @@ -30924,8 +31928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -30945,8 +31949,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -30972,17 +31976,17 @@ paths: category: orgs subcategory: bypass-requests parameters: - - *73 - - &253 + - *75 + - &263 name: repository_name description: The name of the repository to filter on. in: query schema: type: string - - *247 - - *248 - - *249 - - *250 + - *257 + - *258 + - *259 + - *260 - *17 - *19 responses: @@ -30992,11 +31996,11 @@ paths: application/json: schema: type: array - items: *251 + items: *261 examples: - default: *252 + default: *262 '404': *6 - '500': *88 + '500': *90 "/orgs/{org}/bypass-requests/secret-scanning": get: summary: List bypass requests for secret scanning for an org @@ -31017,12 +32021,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *73 - - *253 - - *247 - - *248 - - *249 - - *250 + - *75 + - *263 + - *257 + - *258 + - *259 + - *260 - *17 - *19 responses: @@ -31032,7 +32036,7 @@ paths: application/json: schema: type: array - items: &477 + items: &489 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -31146,7 +32150,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: *254 + items: *264 url: type: string format: uri @@ -31157,7 +32161,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &478 + default: &490 value: - id: 21 number: 42 @@ -31224,7 +32228,7 @@ paths: url: https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/2 html_url: https://github.com/octo-org/smile/exemptions/2 '404': *6 - '500': *88 + '500': *90 "/orgs/{org}/campaigns": get: summary: List campaigns for an organization @@ -31241,15 +32245,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *73 + - *75 - *19 - *17 - - *91 + - *93 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &256 + schema: &266 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -31275,7 +32279,7 @@ paths: application/json: schema: type: array - items: &257 + items: &267 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -31306,7 +32310,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *255 + items: *265 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -31324,7 +32328,7 @@ paths: type: string format: date-time nullable: true - state: *256 + state: *266 contact_link: description: The contact link of the campaign. type: string @@ -31421,7 +32425,7 @@ paths: headers: Link: *40 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31445,7 +32449,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -31539,9 +32543,9 @@ paths: description: Response content: application/json: - schema: *257 + schema: *267 examples: - default: &258 + default: &268 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -31590,7 +32594,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31612,7 +32616,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *73 + - *75 - name: campaign_number description: The campaign number. in: path @@ -31624,16 +32628,16 @@ paths: description: Response content: application/json: - schema: *257 + schema: *267 examples: - default: *258 + default: *268 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31654,7 +32658,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign parameters: - - *73 + - *75 - name: campaign_number description: The campaign number. in: path @@ -31703,7 +32707,7 @@ paths: type: string format: uri nullable: true - state: *256 + state: *266 examples: default: value: @@ -31713,9 +32717,9 @@ paths: description: Response content: application/json: - schema: *257 + schema: *267 examples: - default: *258 + default: *268 '400': description: Bad Request content: @@ -31727,7 +32731,7 @@ paths: content: application/json: schema: *3 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31748,7 +32752,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *73 + - *75 - name: campaign_number description: The campaign number. in: path @@ -31759,7 +32763,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31781,20 +32785,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *73 - - *259 - - *260 - - *89 - - *90 + - *75 + - *269 + - *270 + - *91 + - *92 - *19 - *17 - - *91 + - *93 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: *261 + schema: *271 - name: sort description: The property by which to sort the results. in: query @@ -31810,7 +32814,7 @@ paths: be returned. in: query required: false - schema: &489 + schema: &501 type: string description: Severity of a code scanning alert. enum: @@ -31828,13 +32832,13 @@ paths: application/json: schema: type: array - items: *262 + items: *272 examples: - default: *263 + default: *273 headers: Link: *40 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31856,7 +32860,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *73 + - *75 - name: target_type in: query description: The target type of the code security configuration @@ -31875,8 +32879,8 @@ paths: schema: type: integer default: 30 - - *89 - - *90 + - *91 + - *92 responses: '200': description: Response @@ -31884,7 +32888,7 @@ paths: application/json: schema: type: array - items: *95 + items: *97 examples: default: value: @@ -31967,7 +32971,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *73 + - *75 requestBody: required: true content: @@ -32045,7 +33049,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *264 + code_scanning_options: *274 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -32054,7 +33058,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *98 + code_scanning_default_setup_options: *100 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -32186,9 +33190,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *95 + schema: *97 examples: - default: *265 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32210,15 +33214,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *266 + schema: *276 examples: - default: *267 + default: *277 '304': *37 '403': *29 '404': *6 @@ -32244,7 +33248,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *73 + - *75 requestBody: required: true content: @@ -32270,11 +33274,11 @@ paths: - 32 - 91 responses: - '204': *123 + '204': *125 '400': *14 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32296,16 +33300,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *73 - - *97 + - *75 + - *99 responses: '200': description: Response content: application/json: - schema: *95 + schema: *97 examples: - default: *265 + default: *275 '304': *37 '403': *29 '404': *6 @@ -32329,8 +33333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *73 - - *97 + - *75 + - *99 requestBody: required: true content: @@ -32409,7 +33413,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *98 + code_scanning_default_setup_options: *100 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -32527,7 +33531,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *95 + schema: *97 examples: default: value: @@ -32586,14 +33590,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *73 - - *97 + - *75 + - *99 responses: - '204': *123 + '204': *125 '400': *14 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32617,8 +33621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *73 - - *97 + - *75 + - *99 requestBody: required: true content: @@ -32681,8 +33685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *73 - - *97 + - *75 + - *99 requestBody: required: true content: @@ -32722,12 +33726,12 @@ paths: - none - private_and_internal - public - configuration: *95 + configuration: *97 examples: default: value: default_for_new_repos: all - configuration: *265 + configuration: *275 '403': *29 '404': *6 x-github: @@ -32751,8 +33755,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *73 - - *97 + - *75 + - *99 - 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)." @@ -32761,8 +33765,8 @@ paths: schema: type: integer default: 30 - - *89 - - *90 + - *91 + - *92 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -32780,13 +33784,13 @@ paths: application/json: schema: type: array - items: *268 + items: *278 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *269 + repository: *279 '403': *29 '404': *6 x-github: @@ -32810,7 +33814,7 @@ paths: parameters: - *17 - *19 - - *73 + - *75 responses: '200': description: Response @@ -32826,7 +33830,7 @@ paths: type: integer codespaces: type: array - items: &322 + items: &332 type: object title: Codespace description: A codespace. @@ -32851,12 +33855,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *224 + repository: *234 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &518 + properties: &530 name: type: string description: The name of the machine. @@ -32898,7 +33902,7 @@ paths: - ready - in_progress nullable: true - required: &519 + required: &531 - name - display_name - operating_system @@ -33103,7 +34107,7 @@ paths: - pulls_url - recent_folders examples: - default: &323 + default: &333 value: total_count: 3 codespaces: @@ -33513,7 +34517,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -33535,7 +34539,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *73 + - *75 deprecated: true requestBody: required: true @@ -33579,7 +34583,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33602,7 +34606,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *73 + - *75 deprecated: true requestBody: required: true @@ -33634,7 +34638,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33657,7 +34661,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *73 + - *75 requestBody: required: true content: @@ -33688,7 +34692,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33709,7 +34713,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *73 + - *75 - *17 - *19 responses: @@ -33727,7 +34731,7 @@ paths: type: integer secrets: type: array - items: &270 + items: &280 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -33766,7 +34770,7 @@ paths: - updated_at - visibility examples: - default: &520 + default: &532 value: total_count: 2 secrets: @@ -33798,13 +34802,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: &521 + schema: &533 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -33833,7 +34837,7 @@ paths: - key_id - key examples: - default: &522 + default: &534 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -33856,16 +34860,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 responses: '200': description: Response content: application/json: - schema: *270 + schema: *280 examples: - default: &524 + default: &536 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -33892,8 +34896,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -33948,7 +34952,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -33974,8 +34978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 responses: '204': description: Response @@ -34000,8 +35004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - *19 - *17 responses: @@ -34019,9 +35023,9 @@ paths: type: integer repositories: type: array - items: *224 + items: *234 examples: - default: *238 + default: *248 '404': *6 x-github: githubCloudOnly: false @@ -34043,8 +35047,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -34094,8 +35098,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -34128,8 +35132,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -34168,7 +35172,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *73 + - *75 responses: '200': description: OK @@ -34277,7 +35281,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34299,7 +35303,7 @@ paths: Only organization owners can view assigned seats. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -34309,7 +35313,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *73 + - *75 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -34332,12 +35336,12 @@ paths: currently being billed. seats: type: array - items: *114 + items: *116 examples: - default: *115 + default: *117 headers: Link: *40 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34370,7 +35374,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *73 + - *75 requestBody: content: application/json: @@ -34412,7 +35416,7 @@ paths: default: value: seats_created: 5 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34448,7 +35452,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *73 + - *75 requestBody: content: application/json: @@ -34490,7 +35494,7 @@ paths: default: value: seats_cancelled: 5 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34528,7 +35532,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *73 + - *75 requestBody: content: application/json: @@ -34569,7 +35573,7 @@ paths: default: value: seats_created: 5 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34605,7 +35609,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *73 + - *75 requestBody: content: application/json: @@ -34647,7 +35651,7 @@ paths: default: value: seats_cancelled: 5 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34686,7 +35690,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *73 + - *75 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -34718,13 +35722,13 @@ paths: application/json: schema: type: array - items: *161 + items: *165 examples: - default: *162 - '500': *88 + default: *166 + '500': *90 '403': *29 '404': *6 - '422': *163 + '422': *167 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34746,7 +35750,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - - *73 + - *75 - *17 - name: page description: Page token @@ -34890,7 +35894,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - - *73 + - *75 - name: credential_id in: path required: true @@ -34921,7 +35925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - - *73 + - *75 responses: '200': description: Response - list of custom role names @@ -34936,7 +35940,7 @@ paths: type: integer custom_roles: type: array - items: *271 + items: *281 examples: default: value: @@ -35023,12 +36027,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *73 + - *75 requestBody: required: true content: application/json: - schema: &274 + schema: &284 type: object properties: name: @@ -35069,9 +36073,9 @@ paths: description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '422': *15 '404': *6 x-github: @@ -35095,8 +36099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *73 - - &273 + - *75 + - &283 name: role_id description: The unique identifier of the role. in: path @@ -35108,9 +36112,9 @@ paths: description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '404': *6 x-github: githubCloudOnly: true @@ -35132,13 +36136,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *73 - - *273 + - *75 + - *283 requestBody: required: true content: application/json: - schema: &275 + schema: &285 type: object properties: name: @@ -35176,9 +36180,9 @@ paths: description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '422': *15 '404': *6 x-github: @@ -35202,8 +36206,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *73 - - *273 + - *75 + - *283 responses: '204': description: Response @@ -35231,12 +36235,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - - *73 + - *75 requestBody: required: true content: application/json: - schema: *274 + schema: *284 examples: default: value: @@ -35250,9 +36254,9 @@ paths: description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '422': *15 '404': *6 x-github: @@ -35282,16 +36286,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - - *73 - - *273 + - *75 + - *283 responses: '200': description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '404': *6 x-github: githubCloudOnly: true @@ -35319,13 +36323,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - - *73 - - *273 + - *75 + - *283 requestBody: required: true content: application/json: - schema: *275 + schema: *285 examples: default: value: @@ -35340,9 +36344,9 @@ paths: description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '422': *15 '404': *6 x-github: @@ -35372,8 +36376,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - - *73 - - *273 + - *75 + - *283 responses: '204': description: Response @@ -35401,20 +36405,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *73 - - *276 - - *277 - - *278 - - *279 - - *280 - - *281 - - *282 - - *283 + - *75 + - *286 + - *287 + - *288 + - *289 + - *290 + - *291 + - *292 + - *293 + - *93 - *91 - - *89 - - *90 - - *284 - - *285 + - *92 + - *294 + - *295 - *17 responses: '200': @@ -35423,9 +36427,9 @@ paths: application/json: schema: type: array - items: *286 + items: *296 examples: - default: *287 + default: *297 '304': *37 '400': *14 '403': *29 @@ -35451,7 +36455,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *73 + - *75 - *17 - *19 responses: @@ -35469,7 +36473,7 @@ paths: type: integer secrets: type: array - items: &288 + items: &298 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -35540,13 +36544,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: &551 + schema: &563 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -35563,7 +36567,7 @@ paths: - key_id - key examples: - default: &552 + default: &564 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -35586,14 +36590,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 responses: '200': description: Response content: application/json: - schema: *288 + schema: *298 examples: default: value: @@ -35621,8 +36625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -35677,7 +36681,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -35701,8 +36705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 responses: '204': description: Response @@ -35726,8 +36730,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - *19 - *17 responses: @@ -35745,9 +36749,9 @@ paths: type: integer repositories: type: array - items: *224 + items: *234 examples: - default: *238 + default: *248 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35768,8 +36772,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -35819,8 +36823,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -35851,8 +36855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -35888,8 +36892,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *73 - - &560 + - *75 + - &572 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -35897,7 +36901,7 @@ paths: required: false schema: type: string - - &561 + - &573 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -35905,7 +36909,7 @@ paths: required: false schema: type: string - - &562 + - &574 name: time_period description: |- The time period to filter by. @@ -35921,7 +36925,7 @@ paths: - week - month default: month - - &563 + - &575 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -35936,7 +36940,7 @@ paths: - denied - all default: all - - *253 + - *263 - *17 - *19 responses: @@ -35946,7 +36950,7 @@ paths: application/json: schema: type: array - items: &564 + items: &576 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -36102,7 +37106,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &565 + default: &577 value: - id: 21 number: 42 @@ -36167,7 +37171,7 @@ paths: '404': *6 '403': *29 '422': *15 - '500': *88 + '500': *90 "/orgs/{org}/dismissal-requests/secret-scanning": get: summary: List alert dismissal requests for secret scanning for an org @@ -36188,12 +37192,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *73 - - *253 - - *247 - - *248 - - *249 - - &566 + - *75 + - *263 + - *257 + - *258 + - *259 + - &578 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -36219,7 +37223,7 @@ paths: application/json: schema: type: array - items: &567 + items: &579 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -36329,7 +37333,7 @@ paths: type: array description: The responses to the dismissal request. nullable: true - items: *254 + items: *264 url: type: string format: uri @@ -36340,7 +37344,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &568 + default: &580 value: - id: 21 number: 42 @@ -36405,7 +37409,7 @@ paths: html_url: https://github.com/octo-org/smile/security/secret-scanning/19 '404': *6 '403': *29 - '500': *88 + '500': *90 "/orgs/{org}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for organization @@ -36420,7 +37424,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -36428,7 +37432,7 @@ paths: application/json: schema: type: array - items: &334 + items: &344 title: Package description: A software package type: object @@ -36478,8 +37482,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *289 - required: *290 + properties: *299 + required: *300 nullable: true created_at: type: string @@ -36498,7 +37502,7 @@ paths: - created_at - updated_at examples: - default: &335 + default: &345 value: - id: 197 name: hello_docker @@ -36576,7 +37580,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *73 + - *75 - *17 - *19 responses: @@ -36586,7 +37590,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: 200-response: value: @@ -36656,7 +37660,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *73 + - *75 - name: group_id description: The unique identifier of the group. in: path @@ -36682,7 +37686,7 @@ paths: description: Response content: application/json: - schema: &402 + schema: &414 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -36763,7 +37767,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &403 + default: &415 value: group_id: '123' group_name: Octocat admins @@ -36801,7 +37805,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-in-an-organization parameters: - - *73 + - *75 - *17 - name: page description: Page token @@ -36818,7 +37822,7 @@ paths: description: Response content: application/json: - schema: &400 + schema: &412 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -36855,7 +37859,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &401 + default: &413 value: groups: - group_id: '123' @@ -36889,7 +37893,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *73 + - *75 - *17 - *19 responses: @@ -36899,7 +37903,7 @@ paths: application/json: schema: type: array - items: &313 + items: &323 title: Organization Invitation description: Organization Invitation type: object @@ -36946,7 +37950,7 @@ paths: - invitation_teams_url - node_id examples: - default: &314 + default: &324 value: - id: 1 login: monalisa @@ -37005,7 +38009,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -37013,7 +38017,7 @@ paths: application/json: schema: type: array - items: &356 + items: &366 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -37027,7 +38031,7 @@ paths: - name - description examples: - default: &357 + default: &367 value: - name: add_assignee description: Assign or remove a user @@ -37058,7 +38062,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *73 + - *75 - *17 - *19 responses: @@ -37068,7 +38072,7 @@ paths: application/json: schema: type: array - items: &291 + items: &301 title: Org Hook description: Org Hook type: object @@ -37177,7 +38181,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *73 + - *75 requestBody: required: true content: @@ -37237,9 +38241,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *301 examples: - default: &292 + default: &302 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -37283,8 +38287,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *73 - - &293 + - *75 + - &303 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. @@ -37297,9 +38301,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *301 examples: - default: *292 + default: *302 '404': *6 x-github: githubCloudOnly: false @@ -37320,8 +38324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 requestBody: required: false content: @@ -37366,7 +38370,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *301 examples: default: value: @@ -37405,8 +38409,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 responses: '204': description: Response @@ -37431,8 +38435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *73 - - *293 + - *75 + - *303 responses: '200': description: Response @@ -37460,8 +38464,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *73 - - *293 + - *75 + - *303 requestBody: required: false content: @@ -37509,10 +38513,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 - *17 - - *294 + - *304 responses: '200': description: Response @@ -37520,9 +38524,9 @@ paths: application/json: schema: type: array - items: *295 + items: *305 examples: - default: *296 + default: *306 '400': *14 '422': *15 x-github: @@ -37545,17 +38549,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 - *16 responses: '200': description: Response content: application/json: - schema: *297 + schema: *307 examples: - default: *298 + default: *308 '400': *14 '422': *15 x-github: @@ -37578,8 +38582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 - *16 responses: '202': *39 @@ -37605,8 +38609,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 responses: '204': description: Response @@ -37628,8 +38632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *73 - - &303 + - *75 + - &313 name: actor_type in: path description: The type of the actor @@ -37642,14 +38646,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &304 + - &314 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &299 + - &309 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -37657,7 +38661,7 @@ paths: required: true schema: type: string - - &300 + - &310 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -37668,7 +38672,7 @@ paths: type: string - *19 - *17 - - *91 + - *93 - name: sort description: The property to sort the results by. in: query @@ -37750,13 +38754,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *73 - - *299 - - *300 + - *75 + - *309 + - *310 - *19 - *17 - - *91 - - &309 + - *93 + - &319 name: sort description: The property to sort the results by. in: query @@ -37834,15 +38838,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *73 - - *299 - - *300 + - *75 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &301 + schema: &311 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -37858,7 +38862,7 @@ paths: type: integer format: int64 examples: - default: &302 + default: &312 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -37878,24 +38882,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *73 - - &305 + - *75 + - &315 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *299 - - *300 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *301 + schema: *311 examples: - default: *302 + default: *312 x-github: enabledForGitHubApps: true category: orgs @@ -37913,19 +38917,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *73 - - *299 - - *300 - - *303 - - *304 + - *75 + - *309 + - *310 + - *313 + - *314 responses: '200': description: Response content: application/json: - schema: *301 + schema: *311 examples: - default: *302 + default: *312 x-github: enabledForGitHubApps: true category: orgs @@ -37942,10 +38946,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *73 - - *299 - - *300 - - &306 + - *75 + - *309 + - *310 + - &316 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -37958,7 +38962,7 @@ paths: description: Response content: application/json: - schema: &307 + schema: &317 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -37974,7 +38978,7 @@ paths: type: integer format: int64 examples: - default: &308 + default: &318 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -38010,19 +39014,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *73 - - *305 - - *299 - - *300 - - *306 + - *75 + - *315 + - *309 + - *310 + - *316 responses: '200': description: Response content: application/json: - schema: *307 + schema: *317 examples: - default: *308 + default: *318 x-github: enabledForGitHubApps: true category: orgs @@ -38039,20 +39043,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *73 - - *303 - - *304 - - *299 - - *300 - - *306 + - *75 + - *313 + - *314 + - *309 + - *310 + - *316 responses: '200': description: Response content: application/json: - schema: *307 + schema: *317 examples: - default: *308 + default: *318 x-github: enabledForGitHubApps: true category: orgs @@ -38069,14 +39073,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *73 - - *305 - - *299 - - *300 + - *75 + - *315 + - *309 + - *310 - *19 - *17 - - *91 - - *309 + - *93 + - *319 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -38149,7 +39153,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *73 + - *75 responses: '200': description: Response @@ -38157,7 +39161,7 @@ paths: application/json: schema: *22 examples: - default: &599 + default: &611 value: id: 1 account: @@ -38226,7 +39230,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *73 + - *75 - *17 - *19 responses: @@ -38315,7 +39319,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -38323,12 +39327,12 @@ paths: application/json: schema: anyOf: - - &311 + - &321 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &310 + limit: &320 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -38353,7 +39357,7 @@ paths: properties: {} additionalProperties: false examples: - default: &312 + default: &322 value: limit: collaborators_only origin: organization @@ -38377,18 +39381,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: application/json: - schema: &600 + schema: &612 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *310 + limit: *320 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -38412,9 +39416,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *321 examples: - default: *312 + default: *322 '422': *15 x-github: githubCloudOnly: false @@ -38432,7 +39436,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *73 + - *75 responses: '204': description: Response @@ -38458,7 +39462,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *73 + - *75 - *17 - *19 - name: role @@ -38492,9 +39496,9 @@ paths: application/json: schema: type: array - items: *313 + items: *323 examples: - default: *314 + default: *324 headers: Link: *40 '404': *6 @@ -38518,7 +39522,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *73 + - *75 requestBody: required: false content: @@ -38572,7 +39576,7 @@ paths: description: Response content: application/json: - schema: *313 + schema: *323 examples: default: value: @@ -38628,8 +39632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *73 - - &315 + - *75 + - &325 name: invitation_id description: The unique identifier of the invitation. in: path @@ -38662,8 +39666,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *73 - - *315 + - *75 + - *325 - *17 - *19 responses: @@ -38673,9 +39677,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: &333 + default: &343 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -38710,7 +39714,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -38718,7 +39722,7 @@ paths: application/json: schema: type: array - items: *316 + items: *326 examples: default: value: @@ -38756,7 +39760,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -38803,9 +39807,9 @@ paths: description: Response content: application/json: - schema: *316 + schema: *326 examples: - default: &317 + default: &327 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -38837,8 +39841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *73 - - &318 + - *75 + - &328 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -38891,9 +39895,9 @@ paths: description: Response content: application/json: - schema: *316 + schema: *326 examples: - default: *317 + default: *327 '404': *6 '422': *7 x-github: @@ -38917,8 +39921,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *73 - - *318 + - *75 + - *328 responses: '204': description: Response @@ -38951,7 +39955,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *73 + - *75 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -38981,7 +39985,7 @@ paths: - closed - all default: open - - *319 + - *329 - name: type description: Can be the name of an issue type. in: query @@ -38999,8 +40003,8 @@ paths: - updated - comments default: created - - *91 - - *170 + - *93 + - *174 - *17 - *19 responses: @@ -39010,9 +40014,9 @@ paths: application/json: schema: type: array - items: *180 + items: *184 examples: - default: *320 + default: *330 headers: Link: *40 '404': *6 @@ -39034,7 +40038,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *73 + - *75 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -39072,7 +40076,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '422': *15 @@ -39092,8 +40096,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response if requester is an organization member and user is @@ -39127,8 +40131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -39154,8 +40158,8 @@ paths: parameters: - *17 - *19 - - *73 - - *246 + - *75 + - *256 responses: '200': description: Response @@ -39171,11 +40175,11 @@ paths: type: integer codespaces: type: array - items: *322 + items: *332 examples: - default: *323 + default: *333 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -39198,9 +40202,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *73 - - *246 - - &324 + - *75 + - *256 + - &334 name: codespace_name in: path required: true @@ -39210,7 +40214,7 @@ paths: responses: '202': *39 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -39233,17 +40237,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *73 - - *246 - - *324 + - *75 + - *256 + - *334 responses: '200': description: Response content: application/json: - schema: *322 + schema: *332 examples: - default: &517 + default: &529 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -39385,7 +40389,7 @@ paths: recent_folders: [] template: '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -39404,7 +40408,7 @@ paths: Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -39416,14 +40420,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *114 + schema: *116 examples: default: value: @@ -39466,7 +40470,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -39491,14 +40495,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '200': description: Response content: application/json: - schema: &325 + schema: &335 title: Org Membership description: Org Membership type: object @@ -39542,7 +40546,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *59 + organization: *61 user: title: Simple User description: A GitHub user. @@ -39565,7 +40569,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &326 + response-if-user-has-an-active-admin-membership-with-organization: &336 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -39633,8 +40637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 requestBody: required: false content: @@ -39662,9 +40666,9 @@ paths: description: Response content: application/json: - schema: *325 + schema: *335 examples: - response-if-user-already-had-membership-with-organization: *326 + response-if-user-already-had-membership-with-organization: *336 '422': *15 '403': *29 x-github: @@ -39688,8 +40692,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -39714,7 +40718,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *73 + - *75 - *17 - *19 - name: exclude @@ -39735,7 +40739,7 @@ paths: application/json: schema: type: array - items: &327 + items: &337 title: Migration description: A migration. type: object @@ -39776,7 +40780,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *64 + items: *66 url: type: string format: uri @@ -39988,7 +40992,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *73 + - *75 requestBody: required: true content: @@ -40064,7 +41068,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *337 examples: default: value: @@ -40242,8 +41246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *73 - - &328 + - *75 + - &338 name: migration_id description: The unique identifier of the migration. in: path @@ -40270,7 +41274,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *327 + schema: *337 examples: default: value: @@ -40439,8 +41443,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *73 - - *328 + - *75 + - *338 responses: '302': description: Response @@ -40461,8 +41465,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *73 - - *328 + - *75 + - *338 responses: '204': description: Response @@ -40485,9 +41489,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *73 - - *328 - - &770 + - *75 + - *338 + - &782 name: repo_name description: repo_name parameter in: path @@ -40514,8 +41518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *73 - - *328 + - *75 + - *338 - *17 - *19 responses: @@ -40525,9 +41529,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: &340 + default: &350 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -40666,7 +41670,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -40720,7 +41724,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response - list of organization roles @@ -40736,7 +41740,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &329 + items: &339 title: Organization Role description: Organization roles type: object @@ -40896,7 +41900,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *73 + - *75 requestBody: required: true content: @@ -40943,7 +41947,7 @@ paths: description: Response content: application/json: - schema: *329 + schema: *339 examples: default: value: @@ -40972,7 +41976,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -40994,8 +41998,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *73 - - &330 + - *75 + - &340 name: team_slug description: The slug of the team name. in: path @@ -41026,9 +42030,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *73 - - *330 - - *273 + - *75 + - *340 + - *283 responses: '204': description: Response @@ -41057,9 +42061,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *73 - - *330 - - *273 + - *75 + - *340 + - *283 responses: '204': description: Response @@ -41084,8 +42088,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -41110,9 +42114,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *73 - - *246 - - *273 + - *75 + - *256 + - *283 responses: '204': description: Response @@ -41142,9 +42146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *73 - - *246 - - *273 + - *75 + - *256 + - *283 responses: '204': description: Response @@ -41172,14 +42176,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *73 - - *273 + - *75 + - *283 responses: '200': description: Response content: application/json: - schema: *329 + schema: *339 examples: default: value: @@ -41236,8 +42240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *73 - - *273 + - *75 + - *283 requestBody: required: true content: @@ -41276,7 +42280,7 @@ paths: description: Response content: application/json: - schema: *329 + schema: *339 examples: default: value: @@ -41304,7 +42308,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *99 + '409': *101 '404': *6 x-github: githubCloudOnly: true @@ -41329,8 +42333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *73 - - *273 + - *75 + - *283 responses: '204': description: Response @@ -41355,8 +42359,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *73 - - *273 + - *75 + - *283 - *17 - *19 responses: @@ -41434,8 +42438,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *331 - required: *332 + properties: *341 + required: *342 nullable: true required: - id @@ -41450,7 +42454,7 @@ paths: - slug - parent examples: - default: *333 + default: *343 headers: Link: *40 '404': @@ -41479,8 +42483,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *73 - - *273 + - *75 + - *283 - *17 - *19 responses: @@ -41508,13 +42512,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &374 + items: &386 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *331 - required: *332 + properties: *341 + required: *342 name: nullable: true type: string @@ -41609,7 +42613,7 @@ paths: - type - url examples: - default: *321 + default: *331 headers: Link: *40 '404': @@ -41633,7 +42637,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *73 + - *75 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -41660,7 +42664,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -41685,8 +42689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *73 - - *246 + - *75 + - *256 requestBody: required: false content: @@ -41743,8 +42747,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -41801,8 +42805,8 @@ paths: - docker - nuget - container - - *73 - - &772 + - *75 + - &784 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -41838,12 +42842,12 @@ paths: application/json: schema: type: array - items: *334 + items: *344 examples: - default: *335 + default: *345 '403': *29 '401': *25 - '400': &774 + '400': &786 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -41865,7 +42869,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &336 + - &346 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -41883,20 +42887,20 @@ paths: - docker - nuget - container - - &337 + - &347 name: package_name description: The name of the package. in: path required: true schema: type: string - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *334 + schema: *344 examples: default: value: @@ -41948,9 +42952,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *336 - - *337 - - *73 + - *346 + - *347 + - *75 responses: '204': description: Response @@ -41982,9 +42986,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *336 - - *337 - - *73 + - *346 + - *347 + - *75 - name: token description: package token schema: @@ -42016,9 +43020,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *336 - - *337 - - *73 + - *346 + - *347 + - *75 - *19 - *17 - name: state @@ -42038,7 +43042,7 @@ paths: application/json: schema: type: array - items: &338 + items: &348 title: Package Version description: A version of a software package type: object @@ -42163,10 +43167,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *336 - - *337 - - *73 - - &339 + - *346 + - *347 + - *75 + - &349 name: package_version_id description: Unique identifier of the package version. in: path @@ -42178,7 +43182,7 @@ paths: description: Response content: application/json: - schema: *338 + schema: *348 examples: default: value: @@ -42214,10 +43218,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *336 - - *337 - - *73 - - *339 + - *346 + - *347 + - *75 + - *349 responses: '204': description: Response @@ -42249,10 +43253,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *336 - - *337 - - *73 - - *339 + - *346 + - *347 + - *75 + - *349 responses: '204': description: Response @@ -42279,10 +43283,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *73 + - *75 - *17 - *19 - - &341 + - &351 name: sort description: The property by which to sort the results. in: query @@ -42292,8 +43296,8 @@ paths: enum: - created_at default: created_at - - *91 - - &342 + - *93 + - &352 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -42304,7 +43308,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &343 + - &353 name: repository description: The name of the repository to use to filter the results. in: query @@ -42312,7 +43316,7 @@ paths: schema: type: string example: Hello-World - - &344 + - &354 name: permission description: The permission to use to filter the results. in: query @@ -42320,7 +43324,7 @@ paths: schema: type: string example: issues_read - - &345 + - &355 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -42330,7 +43334,7 @@ paths: schema: type: string format: date-time - - &346 + - &356 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -42340,7 +43344,7 @@ paths: schema: type: string format: date-time - - &347 + - &357 name: token_id description: The ID of the token in: query @@ -42352,7 +43356,7 @@ paths: type: string example: token_id[]=1,token_id[]=2 responses: - '500': *88 + '500': *90 '422': *15 '404': *6 '403': *29 @@ -42504,7 +43508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *73 + - *75 requestBody: required: true content: @@ -42545,7 +43549,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *88 + '500': *90 '422': *15 '404': *6 '403': *29 @@ -42570,7 +43574,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *73 + - *75 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -42606,11 +43610,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *88 + '500': *90 '422': *15 '404': *6 '403': *29 - '204': *123 + '204': *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42631,7 +43635,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *73 + - *75 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -42642,7 +43646,7 @@ paths: - *17 - *19 responses: - '500': *88 + '500': *90 '404': *6 '403': *29 '200': @@ -42651,9 +43655,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -42676,19 +43680,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *73 + - *75 - *17 - *19 - - *341 - - *91 - - *342 - - *343 - - *344 - - *345 - - *346 - - *347 - responses: - '500': *88 + - *351 + - *93 + - *352 + - *353 + - *354 + - *355 + - *356 + - *357 + responses: + '500': *90 '422': *15 '404': *6 '403': *29 @@ -42835,7 +43839,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *73 + - *75 requestBody: required: true content: @@ -42870,7 +43874,7 @@ paths: - 1296269 - 1296280 responses: - '500': *88 + '500': *90 '404': *6 '202': *39 '403': *29 @@ -42895,7 +43899,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *73 + - *75 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -42923,9 +43927,9 @@ paths: value: action: revoke responses: - '500': *88 + '500': *90 '404': *6 - '204': *123 + '204': *125 '403': *29 '422': *15 x-github: @@ -42947,7 +43951,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *73 + - *75 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -42957,7 +43961,7 @@ paths: - *17 - *19 responses: - '500': *88 + '500': *90 '404': *6 '403': *29 '200': @@ -42966,9 +43970,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -42992,7 +43996,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *73 + - *75 - *17 - *19 responses: @@ -43010,7 +44014,7 @@ paths: type: integer configurations: type: array - items: &348 + items: &358 title: Organization private registry description: Private registry configuration for an organization type: object @@ -43098,7 +44102,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -43263,7 +44267,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &349 + org-private-registry-with-selected-visibility: &359 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -43304,7 +44308,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -43352,16 +44356,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *73 - - *234 + - *75 + - *244 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *348 + schema: *358 examples: - default: *349 + default: *359 '404': *6 x-github: githubCloudOnly: false @@ -43382,8 +44386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -43478,8 +44482,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *73 - - *234 + - *75 + - *244 responses: '204': description: Response @@ -43504,7 +44508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects parameters: - - *73 + - *75 - name: state description: Indicates the state of the projects to return. in: query @@ -43525,7 +44529,7 @@ paths: application/json: schema: type: array - items: &350 + items: &360 title: Project description: Projects are a way to organize columns and cards of work. @@ -43672,7 +44676,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project parameters: - - *73 + - *75 requestBody: required: true content: @@ -43698,7 +44702,7 @@ paths: description: Response content: application/json: - schema: *350 + schema: *360 examples: default: value: @@ -43736,7 +44740,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': &418 + '410': &430 description: Gone content: application/json: @@ -43763,7 +44767,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -43771,9 +44775,9 @@ paths: application/json: schema: type: array - items: *119 + items: *121 examples: - default: *120 + default: *122 '403': *29 '404': *6 x-github: @@ -43800,7 +44804,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -43811,7 +44815,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *119 + items: *121 minItems: 1 maxItems: 100 required: @@ -43841,9 +44845,9 @@ paths: application/json: schema: type: array - items: *119 + items: *121 examples: - default: *120 + default: *122 '403': *29 '404': *6 x-github: @@ -43864,16 +44868,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *73 - - *121 + - *75 + - *123 responses: '200': description: Response content: application/json: - schema: *119 + schema: *121 examples: - default: *122 + default: *124 '403': *29 '404': *6 x-github: @@ -43896,13 +44900,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *73 - - *121 + - *75 + - *123 requestBody: required: true content: application/json: - schema: *351 + schema: *361 examples: default: value: @@ -43918,9 +44922,9 @@ paths: description: Response content: application/json: - schema: *119 + schema: *121 examples: - default: *122 + default: *124 '403': *29 '404': *6 x-github: @@ -43943,10 +44947,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *73 - - *121 + - *75 + - *123 responses: - '204': *123 + '204': *125 '403': *29 '404': *6 x-github: @@ -43967,7 +44971,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *73 + - *75 - *17 - *19 - name: repository_query @@ -44005,7 +45009,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &352 + items: &362 title: Custom Property Value description: Custom property name and associated value type: object @@ -44072,7 +45076,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *73 + - *75 requestBody: required: true content: @@ -44092,7 +45096,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *352 + items: *362 required: - repository_names - properties @@ -44133,7 +45137,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *73 + - *75 - *17 - *19 responses: @@ -44145,7 +45149,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -44164,8 +45168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response if user is a public member @@ -44189,8 +45193,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -44211,8 +45215,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -44236,7 +45240,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *73 + - *75 - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation @@ -44283,9 +45287,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -44306,7 +45310,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *73 + - *75 requestBody: required: true content: @@ -44488,7 +45492,7 @@ paths: description: Response content: application/json: - schema: &420 + schema: &432 title: Full Repository description: Full Repository type: object @@ -44765,8 +45769,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *353 - required: *354 + properties: *363 + required: *364 nullable: true temp_clone_token: type: string @@ -44853,8 +45857,8 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true organization: title: Simple User @@ -44863,8 +45867,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *64 - source: *64 + parent: *66 + source: *66 forks: type: integer master_branch: @@ -44881,7 +45885,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &539 + properties: &551 url: type: string format: uri @@ -44897,12 +45901,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &540 + required: &552 - url - key - name - html_url - security_and_analysis: *355 + security_and_analysis: *365 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -44986,7 +45990,7 @@ paths: - network_count - subscribers_count examples: - default: &422 + default: &434 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -45504,7 +46508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -45512,9 +46516,9 @@ paths: application/json: schema: type: array - items: *356 + items: *366 examples: - default: *357 + default: *367 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -45536,10 +46540,10 @@ paths: category: orgs subcategory: rules parameters: - - *73 + - *75 - *17 - *19 - - &668 + - &680 name: targets description: | A comma-separated list of rule targets to filter by. @@ -45557,7 +46561,7 @@ paths: application/json: schema: type: array - items: *152 + items: *154 examples: default: value: @@ -45588,7 +46592,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -45604,7 +46608,7 @@ paths: category: orgs subcategory: rules parameters: - - *73 + - *75 requestBody: description: Request body required: true @@ -45625,22 +46629,20 @@ paths: - push - repository default: branch - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 - conditions: *358 + items: *133 + conditions: *368 rules: type: array description: An array of rules within the ruleset. - items: &360 + items: &370 title: Repository Rule type: object description: A repository rule. oneOf: - - *132 - - *133 - *134 - *135 - *136 @@ -45659,6 +46661,8 @@ paths: - *149 - *150 - *151 + - *152 + - *153 required: - name - enforcement @@ -45696,9 +46700,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: &359 + default: &369 value: id: 21 name: super cool ruleset @@ -45738,7 +46742,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -45752,8 +46756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *73 - - &670 + - *75 + - &682 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -45763,16 +46767,16 @@ paths: schema: type: string x-multi-segment: true - - *253 - - *249 - - &671 + - *263 + - *259 + - &683 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &672 + - &684 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -45792,7 +46796,7 @@ paths: description: Response content: application/json: - schema: &673 + schema: &685 title: Rule Suites description: Response type: array @@ -45847,7 +46851,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &674 + default: &686 value: - id: 21 actor_id: 12 @@ -45871,7 +46875,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45890,8 +46894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *73 - - &675 + - *75 + - &687 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -45907,7 +46911,7 @@ paths: description: Response content: application/json: - schema: &676 + schema: &688 title: Rule Suite description: Response type: object @@ -46006,7 +47010,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &677 + default: &689 value: id: 21 actor_id: 12 @@ -46041,7 +47045,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46067,7 +47071,7 @@ paths: category: orgs subcategory: rules parameters: - - *73 + - *75 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46079,11 +47083,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *359 + default: *369 '404': *6 - '500': *88 + '500': *90 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -46099,7 +47103,7 @@ paths: category: orgs subcategory: rules parameters: - - *73 + - *75 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46125,16 +47129,16 @@ paths: - tag - push - repository - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 - conditions: *358 + items: *133 + conditions: *368 rules: description: An array of rules within the ruleset. type: array - items: *360 + items: *370 examples: default: value: @@ -46169,11 +47173,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *359 + default: *369 '404': *6 - '500': *88 + '500': *90 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -46189,7 +47193,7 @@ paths: category: orgs subcategory: rules parameters: - - *73 + - *75 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46200,7 +47204,7 @@ paths: '204': description: Response '404': *6 - '500': *88 + '500': *90 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -46212,7 +47216,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history parameters: - - *73 + - *75 - *17 - *19 - name: ruleset_id @@ -46228,11 +47232,11 @@ paths: application/json: schema: type: array - items: *156 + items: *158 examples: - default: *361 + default: *371 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46249,7 +47253,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version parameters: - - *73 + - *75 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46267,7 +47271,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *372 examples: default: value: @@ -46307,7 +47311,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46329,15 +47333,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *73 - - *363 - - *364 - - *365 - - *366 - - *91 + - *75 + - *373 + - *374 + - *375 + - *376 + - *93 - *19 - *17 - - &679 + - &691 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -46347,7 +47351,7 @@ paths: required: false schema: type: string - - &680 + - &692 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -46357,10 +47361,10 @@ paths: required: false schema: type: string - - *367 - - *368 - - *369 - - *370 + - *377 + - *378 + - *379 + - *380 responses: '200': description: Response @@ -46368,18 +47372,138 @@ paths: application/json: schema: type: array - items: *371 + items: *381 examples: - default: *372 + default: *382 headers: Link: *40 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/pattern-configurations": + get: + summary: List organization pattern configurations + description: |- + Lists the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *75 + responses: + '200': + description: Response + content: + application/json: + schema: *383 + examples: + default: *384 + '403': *29 + '404': *6 + patch: + summary: Update organization pattern configurations + description: |- + Updates the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *75 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: *161 + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: *161 + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': *14 + '403': *29 + '404': *6 + '409': *101 + '422': *15 "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization @@ -46396,8 +47520,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *73 - - *91 + - *75 + - *93 - name: sort description: The property to sort the results by. in: query @@ -46409,8 +47533,8 @@ paths: - updated - published default: created - - *89 - - *90 + - *91 + - *92 - name: per_page description: The number of advisories to return per page. 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)." @@ -46440,7 +47564,7 @@ paths: application/json: schema: type: array - items: &701 + items: &713 description: A repository security advisory. type: object properties: @@ -46627,7 +47751,7 @@ paths: required: - vector_string - score - cvss_severities: *105 + cvss_severities: *107 cwes: type: array nullable: true @@ -46660,7 +47784,7 @@ paths: login: type: string description: The username of the user credited. - type: *373 + type: *385 credits_detailed: type: array nullable: true @@ -46670,7 +47794,7 @@ paths: type: object properties: user: *4 - type: *373 + type: *385 state: type: string description: The state of the user's acceptance of the @@ -46694,14 +47818,14 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *255 + items: *265 private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *100 + - *102 required: - ghsa_id - cve_id @@ -46731,7 +47855,7 @@ paths: - private_fork additionalProperties: false examples: - default: &702 + default: &714 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -47110,7 +48234,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *73 + - *75 responses: '200': description: Response @@ -47118,9 +48242,9 @@ paths: application/json: schema: type: array - items: *374 + items: *386 examples: - default: *333 + default: *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47143,8 +48267,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '204': description: Response @@ -47169,8 +48293,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '204': description: Response @@ -47199,15 +48323,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *375 + schema: *387 examples: - default: *376 + default: *388 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47231,8 +48355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - - *73 - - *377 + - *75 + - *389 - *17 - *19 responses: @@ -47240,9 +48364,9 @@ paths: description: Success content: application/json: - schema: *378 + schema: *390 examples: - default: *379 + default: *391 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -47264,15 +48388,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *380 + schema: *392 examples: - default: *381 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47294,15 +48418,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *382 + schema: *394 examples: - default: *383 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47322,7 +48446,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *73 + - *75 - *17 - *19 responses: @@ -47340,9 +48464,9 @@ paths: type: integer network_configurations: type: array - items: *116 + items: *118 examples: - default: *384 + default: *396 headers: Link: *40 x-github: @@ -47363,7 +48487,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -47405,9 +48529,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: *117 + default: *119 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47427,16 +48551,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *73 - - *118 + - *75 + - *120 responses: '200': description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: *117 + default: *119 headers: Link: *40 x-github: @@ -47457,8 +48581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *73 - - *118 + - *75 + - *120 requestBody: required: true content: @@ -47497,9 +48621,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: *117 + default: *119 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47518,8 +48642,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *73 - - *118 + - *75 + - *120 responses: '204': description: Response @@ -47542,16 +48666,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *73 - - *385 + - *75 + - *397 responses: '200': description: Response content: application/json: - schema: *386 + schema: *398 examples: - default: *387 + default: *399 headers: Link: *40 x-github: @@ -47570,7 +48694,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - - *73 + - *75 - *17 - name: page description: Page token @@ -47589,7 +48713,7 @@ paths: description: Response content: application/json: - schema: &409 + schema: &421 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -47635,7 +48759,7 @@ paths: type: string nullable: true examples: - default: &410 + default: &422 value: groups: - group_id: '123' @@ -47680,8 +48804,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *73 - - *330 + - *75 + - *340 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -47713,13 +48837,13 @@ paths: application/json: schema: type: array - items: *161 + items: *165 examples: - default: *162 - '500': *88 + default: *166 + '500': *90 '403': *29 '404': *6 - '422': *163 + '422': *167 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47737,7 +48861,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *73 + - *75 - *17 - *19 responses: @@ -47747,9 +48871,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 headers: Link: *40 '403': *29 @@ -47771,7 +48895,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *73 + - *75 requestBody: required: true content: @@ -47843,7 +48967,7 @@ paths: description: Response content: application/json: - schema: &388 + schema: &400 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -47906,8 +49030,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *331 - required: *332 + properties: *341 + required: *342 nullable: true members_count: type: integer @@ -48153,7 +49277,7 @@ paths: - repos_count - organization examples: - default: &389 + default: &401 value: id: 1 node_id: MDQ6VGVhbTE= @@ -48223,16 +49347,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *73 - - *330 + - *75 + - *340 responses: '200': description: Response content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '404': *6 x-github: githubCloudOnly: false @@ -48253,8 +49377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *73 - - *330 + - *75 + - *340 requestBody: required: false content: @@ -48316,16 +49440,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '201': description: Response content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '404': *6 '422': *15 '403': *29 @@ -48350,8 +49474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '204': description: Response @@ -48377,9 +49501,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *73 - - *330 - - *91 + - *75 + - *340 + - *93 - *17 - *19 - name: pinned @@ -48395,7 +49519,7 @@ paths: application/json: schema: type: array - items: &390 + items: &402 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -48474,7 +49598,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *168 + reactions: *172 required: - author - body @@ -48494,7 +49618,7 @@ paths: - updated_at - url examples: - default: &743 + default: &756 value: - author: login: octocat @@ -48568,8 +49692,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *73 - - *330 + - *75 + - *340 requestBody: required: true content: @@ -48603,9 +49727,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: &391 + default: &403 value: author: login: octocat @@ -48677,9 +49801,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *73 - - *330 - - &392 + - *75 + - *340 + - &404 name: discussion_number description: The number that identifies the discussion. in: path @@ -48691,9 +49815,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: *391 + default: *403 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48715,9 +49839,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *73 - - *330 - - *392 + - *75 + - *340 + - *404 requestBody: required: false content: @@ -48740,9 +49864,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: &744 + default: &757 value: author: login: octocat @@ -48812,9 +49936,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *73 - - *330 - - *392 + - *75 + - *340 + - *404 responses: '204': description: Response @@ -48840,10 +49964,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *73 - - *330 - - *392 - - *91 + - *75 + - *340 + - *404 + - *93 - *17 - *19 responses: @@ -48853,7 +49977,7 @@ paths: application/json: schema: type: array - items: &393 + items: &405 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -48910,7 +50034,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *168 + reactions: *172 required: - author - body @@ -48925,7 +50049,7 @@ paths: - updated_at - url examples: - default: &745 + default: &758 value: - author: login: octocat @@ -48993,9 +50117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *73 - - *330 - - *392 + - *75 + - *340 + - *404 requestBody: required: true content: @@ -49017,9 +50141,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: &394 + default: &406 value: author: login: octocat @@ -49085,10 +50209,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *73 - - *330 - - *392 - - &395 + - *75 + - *340 + - *404 + - &407 name: comment_number description: The number that identifies the comment. in: path @@ -49100,9 +50224,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: *394 + default: *406 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49124,10 +50248,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *73 - - *330 - - *392 - - *395 + - *75 + - *340 + - *404 + - *407 requestBody: required: true content: @@ -49149,9 +50273,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: &746 + default: &759 value: author: login: octocat @@ -49215,10 +50339,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *73 - - *330 - - *392 - - *395 + - *75 + - *340 + - *404 + - *407 responses: '204': description: Response @@ -49244,10 +50368,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *73 - - *330 - - *392 - - *395 + - *75 + - *340 + - *404 + - *407 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -49273,7 +50397,7 @@ paths: application/json: schema: type: array - items: &396 + items: &408 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -49316,7 +50440,7 @@ paths: - content - created_at examples: - default: &398 + default: &410 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -49366,10 +50490,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *73 - - *330 - - *392 - - *395 + - *75 + - *340 + - *404 + - *407 requestBody: required: true content: @@ -49402,9 +50526,9 @@ paths: team discussion comment content: application/json: - schema: *396 + schema: *408 examples: - default: &397 + default: &409 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -49433,9 +50557,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49458,11 +50582,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *73 - - *330 - - *392 - - *395 - - &399 + - *75 + - *340 + - *404 + - *407 + - &411 name: reaction_id description: The unique identifier of the reaction. in: path @@ -49494,9 +50618,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *73 - - *330 - - *392 + - *75 + - *340 + - *404 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -49522,9 +50646,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 x-github: @@ -49550,9 +50674,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *73 - - *330 - - *392 + - *75 + - *340 + - *404 requestBody: required: true content: @@ -49584,16 +50708,16 @@ paths: description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -49616,10 +50740,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *73 - - *330 - - *392 - - *399 + - *75 + - *340 + - *404 + - *411 responses: '204': description: Response @@ -49642,16 +50766,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '200': description: Response content: application/json: - schema: *400 + schema: *412 examples: - default: *401 + default: *413 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -49670,8 +50794,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - - *73 - - *330 + - *75 + - *340 requestBody: required: true content: @@ -49694,9 +50818,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *414 examples: - default: *403 + default: *415 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -49715,8 +50839,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '204': description: Response @@ -49740,8 +50864,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *73 - - *330 + - *75 + - *340 - *17 - *19 responses: @@ -49751,9 +50875,9 @@ paths: application/json: schema: type: array - items: *313 + items: *323 examples: - default: *314 + default: *324 headers: Link: *40 x-github: @@ -49775,8 +50899,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *73 - - *330 + - *75 + - *340 - name: role description: Filters members returned by their role in the team. in: query @@ -49799,7 +50923,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -49829,15 +50953,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *73 - - *330 - - *246 + - *75 + - *340 + - *256 responses: '200': description: Response content: application/json: - schema: &404 + schema: &416 title: Team Membership description: Team Membership type: object @@ -49864,7 +50988,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &747 + response-if-user-is-a-team-maintainer: &760 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -49900,9 +51024,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *73 - - *330 - - *246 + - *75 + - *340 + - *256 requestBody: required: false content: @@ -49927,9 +51051,9 @@ paths: description: Response content: application/json: - schema: *404 + schema: *416 examples: - response-if-users-membership-with-team-is-now-pending: &748 + response-if-users-membership-with-team-is-now-pending: &761 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -49964,9 +51088,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *73 - - *330 - - *246 + - *75 + - *340 + - *256 responses: '204': description: Response @@ -49991,8 +51115,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *73 - - *330 + - *75 + - *340 - *17 - *19 responses: @@ -50002,7 +51126,7 @@ paths: application/json: schema: type: array - items: &405 + items: &417 title: Team Project description: A team's access to a project. type: object @@ -50070,7 +51194,7 @@ paths: - updated_at - permissions examples: - default: &749 + default: &762 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -50133,9 +51257,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *73 - - *330 - - &406 + - *75 + - *340 + - &418 name: project_id description: The unique identifier of the project. in: path @@ -50147,9 +51271,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *417 examples: - default: &750 + default: &763 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -50211,9 +51335,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *73 - - *330 - - *406 + - *75 + - *340 + - *418 requestBody: required: false content: @@ -50279,9 +51403,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *73 - - *330 - - *406 + - *75 + - *340 + - *418 responses: '204': description: Response @@ -50308,8 +51432,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *73 - - *330 + - *75 + - *340 - *17 - *19 responses: @@ -50319,9 +51443,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -50350,16 +51474,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *73 - - *330 - - *407 - - *408 + - *75 + - *340 + - *419 + - *420 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &751 + schema: &764 title: Team Repository description: A team's access to a repository. type: object @@ -50382,8 +51506,8 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true forks: type: integer @@ -50928,10 +52052,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *73 - - *330 - - *407 - - *408 + - *75 + - *340 + - *419 + - *420 requestBody: required: false content: @@ -50976,10 +52100,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *73 - - *330 - - *407 - - *408 + - *75 + - *340 + - *419 + - *420 responses: '204': description: Response @@ -51005,16 +52129,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '200': description: Response content: application/json: - schema: *409 + schema: *421 examples: - default: *410 + default: *422 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -51036,8 +52160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - - *73 - - *330 + - *75 + - *340 requestBody: required: true content: @@ -51080,7 +52204,7 @@ paths: description: Response content: application/json: - schema: *409 + schema: *421 examples: default: value: @@ -51112,8 +52236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *73 - - *330 + - *75 + - *340 - *17 - *19 responses: @@ -51123,9 +52247,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - response-if-child-teams-exist: &752 + response-if-child-teams-exist: &765 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -51178,7 +52302,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *73 + - *75 - name: security_product in: path description: The security feature to enable or disable. @@ -51252,7 +52376,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &411 + - &423 name: card_id description: The unique identifier of the card. in: path @@ -51264,7 +52388,7 @@ paths: description: Response content: application/json: - schema: &412 + schema: &424 title: Project Card description: Project cards represent a scope of work. type: object @@ -51331,7 +52455,7 @@ paths: - created_at - updated_at examples: - default: &413 + default: &425 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -51387,7 +52511,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *411 + - *423 requestBody: required: false content: @@ -51414,9 +52538,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *424 examples: - default: *413 + default: *425 '304': *37 '403': *29 '401': *25 @@ -51443,7 +52567,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *411 + - *423 responses: '204': description: Response @@ -51487,7 +52611,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *411 + - *423 requestBody: required: true content: @@ -51598,7 +52722,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &414 + - &426 name: column_id description: The unique identifier of the column. in: path @@ -51610,7 +52734,7 @@ paths: description: Response content: application/json: - schema: &415 + schema: &427 title: Project Column description: Project columns contain cards of work. type: object @@ -51656,7 +52780,7 @@ paths: - created_at - updated_at examples: - default: &416 + default: &428 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -51691,7 +52815,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *414 + - *426 requestBody: required: true content: @@ -51715,9 +52839,9 @@ paths: description: Response content: application/json: - schema: *415 + schema: *427 examples: - default: *416 + default: *428 '304': *37 '403': *29 '401': *25 @@ -51742,7 +52866,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *414 + - *426 responses: '204': description: Response @@ -51771,7 +52895,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *414 + - *426 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -51792,7 +52916,7 @@ paths: application/json: schema: type: array - items: *412 + items: *424 examples: default: value: @@ -51851,7 +52975,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *414 + - *426 requestBody: required: true content: @@ -51891,9 +53015,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *424 examples: - default: *413 + default: *425 '304': *37 '403': *29 '401': *25 @@ -51903,8 +53027,8 @@ paths: application/json: schema: oneOf: - - *207 - - *208 + - *217 + - *218 '503': description: Response content: @@ -51949,7 +53073,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *414 + - *426 requestBody: required: true content: @@ -52009,15 +53133,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project parameters: - - *406 + - *418 responses: '200': description: Response content: application/json: - schema: *350 + schema: *360 examples: - default: &417 + default: &429 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -52074,7 +53198,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project parameters: - - *406 + - *418 requestBody: required: false content: @@ -52120,9 +53244,9 @@ paths: description: Response content: application/json: - schema: *350 + schema: *360 examples: - default: *417 + default: *429 '404': description: Not Found if the authenticated user does not have access to the project @@ -52143,7 +53267,7 @@ paths: items: type: string '401': *25 - '410': *418 + '410': *430 '422': *7 x-github: githubCloudOnly: false @@ -52166,7 +53290,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project parameters: - - *406 + - *418 responses: '204': description: Delete Success @@ -52187,7 +53311,7 @@ paths: items: type: string '401': *25 - '410': *418 + '410': *430 '404': *6 x-github: githubCloudOnly: false @@ -52211,7 +53335,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *406 + - *418 - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's @@ -52238,7 +53362,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '404': *6 @@ -52268,8 +53392,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *406 - - *246 + - *418 + - *256 requestBody: required: false content: @@ -52321,8 +53445,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *406 - - *246 + - *418 + - *256 responses: '204': description: Response @@ -52353,8 +53477,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *406 - - *246 + - *418 + - *256 responses: '200': description: Response @@ -52427,7 +53551,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#list-project-columns parameters: - - *406 + - *418 - *17 - *19 responses: @@ -52437,7 +53561,7 @@ paths: application/json: schema: type: array - items: *415 + items: *427 examples: default: value: @@ -52475,7 +53599,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#create-a-project-column parameters: - - *406 + - *418 requestBody: required: true content: @@ -52498,7 +53622,7 @@ paths: description: Response content: application/json: - schema: *415 + schema: *427 examples: default: value: @@ -52563,7 +53687,7 @@ paths: resources: type: object properties: - core: &419 + core: &431 title: Rate Limit type: object properties: @@ -52580,21 +53704,21 @@ paths: - remaining - reset - used - graphql: *419 - search: *419 - code_search: *419 - source_import: *419 - integration_manifest: *419 - code_scanning_upload: *419 - actions_runner_registration: *419 - scim: *419 - dependency_snapshots: *419 - dependency_sbom: *419 - code_scanning_autofix: *419 + graphql: *431 + search: *431 + code_search: *431 + source_import: *431 + integration_manifest: *431 + code_scanning_upload: *431 + actions_runner_registration: *431 + scim: *431 + dependency_snapshots: *431 + dependency_sbom: *431 + code_scanning_autofix: *431 required: - core - search - rate: *419 + rate: *431 required: - rate - resources @@ -52698,14 +53822,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *420 + schema: *432 examples: default-response: summary: Default response @@ -53210,7 +54334,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *421 + '301': *433 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53228,8 +54352,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -53486,10 +54610,10 @@ paths: description: Response content: application/json: - schema: *420 + schema: *432 examples: - default: *422 - '307': &423 + default: *434 + '307': &435 description: Temporary Redirect content: application/json: @@ -53518,8 +54642,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -53541,9 +54665,9 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *423 + '307': *435 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53565,11 +54689,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 - - &438 + - &450 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -53592,7 +54716,7 @@ paths: type: integer artifacts: type: array - items: &424 + items: &436 title: Artifact description: An artifact type: object @@ -53670,7 +54794,7 @@ paths: - expires_at - updated_at examples: - default: &439 + default: &451 value: total_count: 2 artifacts: @@ -53731,9 +54855,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *407 - - *408 - - &425 + - *419 + - *420 + - &437 name: artifact_id description: The unique identifier of the artifact. in: path @@ -53745,7 +54869,7 @@ paths: description: Response content: application/json: - schema: *424 + schema: *436 examples: default: value: @@ -53783,9 +54907,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *407 - - *408 - - *425 + - *419 + - *420 + - *437 responses: '204': description: Response @@ -53809,9 +54933,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *407 - - *408 - - *425 + - *419 + - *420 + - *437 - name: archive_format in: path required: true @@ -53825,7 +54949,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53848,14 +54972,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *426 + schema: *438 examples: default: value: @@ -53881,11 +55005,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 - - &427 + - &439 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -53913,13 +55037,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *91 + - *93 responses: '200': description: Response content: application/json: - schema: &428 + schema: &440 title: Repository actions caches description: Repository actions caches type: object @@ -53961,7 +55085,7 @@ paths: - total_count - actions_caches examples: - default: &429 + default: &441 value: total_count: 1 actions_caches: @@ -53993,23 +55117,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *407 - - *408 + - *419 + - *420 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *427 + - *439 responses: '200': description: Response content: application/json: - schema: *428 + schema: *440 examples: - default: *429 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54029,8 +55153,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *407 - - *408 + - *419 + - *420 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -54061,9 +55185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *407 - - *408 - - &430 + - *419 + - *420 + - &442 name: job_id description: The unique identifier of the job. in: path @@ -54075,7 +55199,7 @@ paths: description: Response content: application/json: - schema: &442 + schema: &454 title: Job description: Information of a job execution in a workflow run type: object @@ -54382,9 +55506,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *407 - - *408 - - *430 + - *419 + - *420 + - *442 responses: '302': description: Response @@ -54412,9 +55536,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *407 - - *408 - - *430 + - *419 + - *420 + - *442 requestBody: required: false content: @@ -54435,7 +55559,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -54459,8 +55583,8 @@ paths: 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-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Status response @@ -54510,8 +55634,8 @@ paths: 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-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -54545,7 +55669,7 @@ paths: description: Empty response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -54574,8 +55698,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -54593,7 +55717,7 @@ paths: type: integer secrets: type: array - items: &444 + items: &456 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -54613,7 +55737,7 @@ paths: - created_at - updated_at examples: - default: &445 + default: &457 value: total_count: 2 secrets: @@ -54646,9 +55770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *407 - - *408 - - *431 + - *419 + - *420 + - *443 - *19 responses: '200': @@ -54665,7 +55789,7 @@ paths: type: integer variables: type: array - items: &448 + items: &460 title: Actions Variable type: object properties: @@ -54695,7 +55819,7 @@ paths: - created_at - updated_at examples: - default: &449 + default: &461 value: total_count: 2 variables: @@ -54728,8 +55852,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -54738,11 +55862,11 @@ paths: schema: type: object properties: - enabled: &432 + enabled: &444 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *49 - selected_actions_url: *217 + selected_actions_url: *227 required: - enabled examples: @@ -54771,8 +55895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -54783,7 +55907,7 @@ paths: schema: type: object properties: - enabled: *432 + enabled: *444 allowed_actions: *49 required: - enabled @@ -54814,14 +55938,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: &433 + schema: &445 type: object properties: access_level: @@ -54839,7 +55963,7 @@ paths: required: - access_level examples: - default: &434 + default: &446 value: access_level: organization x-github: @@ -54864,15 +55988,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: application/json: - schema: *433 + schema: *445 examples: - default: *434 + default: *446 responses: '204': description: Response @@ -54882,6 +56006,196 @@ paths: previews: [] category: actions subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for a repository + description: |- + Gets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository + 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-a-repository + parameters: + - *419 + - *420 + responses: + '200': + description: Response + content: + application/json: + schema: *201 + examples: + default: + value: + days: 90 + maximum_allowed_days: 365 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for a repository + description: |- + Sets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-repository + 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-a-repository + parameters: + - *419 + - *420 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *202 + examples: + default: + summary: Set retention days + value: + days: 90 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for a repository + description: |- + Gets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository + 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-a-repository + parameters: + - *419 + - *420 + responses: + '200': + description: Response + content: + application/json: + schema: *50 + examples: + default: *203 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for a repository + description: |- + Sets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository + 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-a-repository + parameters: + - *419 + - *420 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *50 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for a repository + description: |- + Gets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository + 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-a-repository + parameters: + - *419 + - *420 + responses: + '200': + description: Response + content: + application/json: + schema: *204 + examples: + default: *51 + '403': *29 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for a repository + description: |- + Sets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository + 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-a-repository + parameters: + - *419 + - *420 + requestBody: + required: true + content: + application/json: + schema: *205 + examples: + default: *51 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/selected-actions": get: summary: Get allowed actions and reusable workflows for a repository @@ -54896,16 +56210,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *51 + schema: *53 examples: - default: *52 + default: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -54928,8 +56242,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -54937,9 +56251,9 @@ paths: required: false content: application/json: - schema: *51 + schema: *53 examples: - selected_actions: *52 + selected_actions: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -54961,16 +56275,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *220 + schema: *230 examples: - default: *55 + default: *57 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54991,8 +56305,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Success response @@ -55003,9 +56317,9 @@ paths: required: true content: application/json: - schema: *221 + schema: *231 examples: - default: *55 + default: *57 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55032,8 +56346,8 @@ paths: in: query schema: type: string - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -55051,9 +56365,9 @@ paths: type: integer runners: type: array - items: *62 + items: *64 examples: - default: *63 + default: *65 headers: Link: *40 x-github: @@ -55077,8 +56391,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -55086,9 +56400,9 @@ paths: application/json: schema: type: array - items: *225 + items: *235 examples: - default: *226 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55110,8 +56424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -55154,10 +56468,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *227 + '201': *237 '404': *6 '422': *7 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55185,16 +56499,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '201': description: Response content: application/json: - schema: *65 + schema: *67 examples: - default: *228 + default: *238 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55222,16 +56536,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '201': description: Response content: application/json: - schema: *65 + schema: *67 examples: - default: *229 + default: *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55253,17 +56567,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 responses: '200': description: Response content: application/json: - schema: *62 + schema: *64 examples: - default: *230 + default: *240 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55284,9 +56598,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 responses: '204': description: Response @@ -55312,11 +56626,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 responses: - '200': *67 + '200': *69 '404': *6 x-github: githubCloudOnly: false @@ -55338,9 +56652,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 requestBody: required: true content: @@ -55364,7 +56678,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -55388,9 +56702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 requestBody: required: true content: @@ -55415,7 +56729,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -55439,11 +56753,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 responses: - '200': *231 + '200': *241 '404': *6 x-github: githubCloudOnly: false @@ -55470,12 +56784,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 - - *232 + - *419 + - *420 + - *63 + - *242 responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -55501,9 +56815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *407 - - *408 - - &452 + - *419 + - *420 + - &464 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -55511,7 +56825,7 @@ paths: required: false schema: type: string - - &453 + - &465 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -55519,7 +56833,7 @@ paths: required: false schema: type: string - - &454 + - &466 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -55528,7 +56842,7 @@ paths: required: false schema: type: string - - &455 + - &467 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -55555,7 +56869,7 @@ paths: - pending - *17 - *19 - - &456 + - &468 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -55564,7 +56878,7 @@ paths: schema: type: string format: date-time - - &435 + - &447 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -55573,13 +56887,13 @@ paths: schema: type: boolean default: false - - &457 + - &469 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &458 + - &470 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -55602,7 +56916,7 @@ paths: type: integer workflow_runs: type: array - items: &436 + items: &448 title: Workflow Run description: An invocation of a workflow type: object @@ -55697,7 +57011,7 @@ paths: that triggered the run. type: array nullable: true - items: &479 + items: &491 title: Pull Request Minimal type: object properties: @@ -55816,7 +57130,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &483 + properties: &495 id: type: string description: SHA for the commit @@ -55867,7 +57181,7 @@ paths: - name - email nullable: true - required: &484 + required: &496 - id - tree_id - message @@ -55875,8 +57189,8 @@ paths: - author - committer nullable: true - repository: *224 - head_repository: *224 + repository: *234 + head_repository: *234 head_repository_id: type: integer example: 5 @@ -55914,7 +57228,7 @@ paths: - workflow_url - pull_requests examples: - default: &459 + default: &471 value: total_count: 1 workflow_runs: @@ -56150,24 +57464,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *407 - - *408 - - &437 + - *419 + - *420 + - &449 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *435 + - *447 responses: '200': description: Response content: application/json: - schema: *436 + schema: *448 examples: - default: &440 + default: &452 value: id: 30433642 name: Build @@ -56408,9 +57722,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '204': description: Response @@ -56433,9 +57747,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '200': description: Response @@ -56554,15 +57868,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '201': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -56589,12 +57903,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 - *17 - *19 - - *438 + - *450 responses: '200': description: Response @@ -56610,9 +57924,9 @@ paths: type: integer artifacts: type: array - items: *424 + items: *436 examples: - default: *439 + default: *451 headers: Link: *40 x-github: @@ -56636,25 +57950,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *407 - - *408 - - *437 - - &441 + - *419 + - *420 + - *449 + - &453 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *435 + - *447 responses: '200': description: Response content: application/json: - schema: *436 + schema: *448 examples: - default: *440 + default: *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56677,10 +57991,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *407 - - *408 - - *437 - - *441 + - *419 + - *420 + - *449 + - *453 - *17 - *19 responses: @@ -56698,9 +58012,9 @@ paths: type: integer jobs: type: array - items: *442 + items: *454 examples: - default: &443 + default: &455 value: total_count: 1 jobs: @@ -56813,10 +58127,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *407 - - *408 - - *437 - - *441 + - *419 + - *420 + - *449 + - *453 responses: '302': description: Response @@ -56844,19 +58158,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '202': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56879,9 +58193,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 requestBody: required: true content: @@ -56948,19 +58262,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '202': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56983,9 +58297,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -57015,9 +58329,9 @@ paths: type: integer jobs: type: array - items: *442 + items: *454 examples: - default: *443 + default: *455 headers: Link: *40 x-github: @@ -57042,9 +58356,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '302': description: Response @@ -57071,14 +58385,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '204': description: Response '403': *29 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57100,9 +58414,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '200': description: Response @@ -57162,7 +58476,7 @@ paths: items: type: object properties: - type: &569 + type: &581 type: string description: The type of reviewer. enum: @@ -57172,7 +58486,7 @@ paths: reviewer: anyOf: - *4 - - *255 + - *265 required: - environment - wait_timer @@ -57247,9 +58561,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 requestBody: required: true content: @@ -57296,7 +58610,7 @@ paths: application/json: schema: type: array - items: &555 + items: &567 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -57384,8 +58698,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 required: - id - node_id @@ -57402,7 +58716,7 @@ paths: - created_at - updated_at examples: - default: &556 + default: &568 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -57458,9 +58772,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 requestBody: required: false content: @@ -57481,7 +58795,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -57504,9 +58818,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 requestBody: required: false content: @@ -57527,7 +58841,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -57560,9 +58874,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '200': description: Response @@ -57699,8 +59013,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -57718,9 +59032,9 @@ paths: type: integer secrets: type: array - items: *444 + items: *456 examples: - default: *445 + default: *457 headers: Link: *40 x-github: @@ -57745,16 +59059,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *446 + schema: *458 examples: - default: *447 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57776,17 +59090,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '200': description: Response content: application/json: - schema: *444 + schema: *456 examples: - default: &582 + default: &594 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -57812,9 +59126,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 requestBody: required: true content: @@ -57845,7 +59159,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -57871,9 +59185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '204': description: Response @@ -57898,9 +59212,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *407 - - *408 - - *431 + - *419 + - *420 + - *443 - *19 responses: '200': @@ -57917,9 +59231,9 @@ paths: type: integer variables: type: array - items: *448 + items: *460 examples: - default: *449 + default: *461 headers: Link: *40 x-github: @@ -57942,8 +59256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -57970,7 +59284,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -57995,17 +59309,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *407 - - *408 - - *237 + - *419 + - *420 + - *247 responses: '200': description: Response content: application/json: - schema: *448 + schema: *460 examples: - default: &583 + default: &595 value: name: USERNAME value: octocat @@ -58031,9 +59345,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *407 - - *408 - - *237 + - *419 + - *420 + - *247 requestBody: required: true content: @@ -58075,9 +59389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *407 - - *408 - - *237 + - *419 + - *420 + - *247 responses: '204': description: Response @@ -58102,8 +59416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -58121,7 +59435,7 @@ paths: type: integer workflows: type: array - items: &450 + items: &462 title: Workflow description: A GitHub Actions workflow type: object @@ -58228,9 +59542,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *407 - - *408 - - &451 + - *419 + - *420 + - &463 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -58245,7 +59559,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *462 examples: default: value: @@ -58278,9 +59592,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *407 - - *408 - - *451 + - *419 + - *420 + - *463 responses: '204': description: Response @@ -58305,9 +59619,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *407 - - *408 - - *451 + - *419 + - *420 + - *463 responses: '204': description: Response @@ -58358,9 +59672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *407 - - *408 - - *451 + - *419 + - *420 + - *463 responses: '204': description: Response @@ -58387,19 +59701,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *407 - - *408 - - *451 - - *452 - - *453 - - *454 - - *455 + - *419 + - *420 + - *463 + - *464 + - *465 + - *466 + - *467 - *17 - *19 - - *456 - - *435 - - *457 - - *458 + - *468 + - *447 + - *469 + - *470 responses: '200': description: Response @@ -58415,9 +59729,9 @@ paths: type: integer workflow_runs: type: array - items: *436 + items: *448 examples: - default: *459 + default: *471 headers: Link: *40 x-github: @@ -58450,9 +59764,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *407 - - *408 - - *451 + - *419 + - *420 + - *463 responses: '200': description: Response @@ -58513,12 +59827,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *407 - - *408 - - *91 + - *419 + - *420 + - *93 - *17 - - *89 - - *90 + - *91 + - *92 - name: ref description: |- The Git reference for the activities you want to list. @@ -58678,8 +59992,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -58691,7 +60005,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '404': *6 @@ -58716,8 +60030,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *407 - - *408 + - *419 + - *420 - name: assignee in: path required: true @@ -58753,8 +60067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -58866,11 +60180,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *407 - - *408 + - *419 + - *420 - *17 - - *89 - - *90 + - *91 + - *92 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -58921,7 +60235,7 @@ paths: bundle_url: type: string examples: - default: *460 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58941,8 +60255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -58950,7 +60264,7 @@ paths: application/json: schema: type: array - items: &461 + items: &473 title: Autolink reference description: An autolink reference. type: object @@ -59000,8 +60314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -59040,9 +60354,9 @@ paths: description: response content: application/json: - schema: *461 + schema: *473 examples: - default: &462 + default: &474 value: id: 1 key_prefix: TICKET- @@ -59073,9 +60387,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *407 - - *408 - - &463 + - *419 + - *420 + - &475 name: autolink_id description: The unique identifier of the autolink. in: path @@ -59087,9 +60401,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *473 examples: - default: *462 + default: *474 '404': *6 x-github: githubCloudOnly: false @@ -59109,9 +60423,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *407 - - *408 - - *463 + - *419 + - *420 + - *475 responses: '204': description: Response @@ -59135,8 +60449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response if Dependabot is enabled @@ -59184,8 +60498,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -59206,8 +60520,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -59227,8 +60541,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *407 - - *408 + - *419 + - *420 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -59266,7 +60580,7 @@ paths: - url protected: type: boolean - protection: &465 + protection: &477 title: Branch Protection description: Branch Protection type: object @@ -59308,7 +60622,7 @@ paths: required: - contexts - checks - enforce_admins: &468 + enforce_admins: &480 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -59323,7 +60637,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &470 + required_pull_request_reviews: &482 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -59344,7 +60658,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *255 + items: *265 apps: description: The list of apps with review dismissal access. @@ -59373,7 +60687,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *255 + items: *265 apps: description: The list of apps allowed to bypass pull request requirements. @@ -59399,7 +60713,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &467 + restrictions: &479 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -59706,9 +61020,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *407 - - *408 - - &466 + - *419 + - *420 + - &478 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -59722,14 +61036,14 @@ paths: description: Response content: application/json: - schema: &476 + schema: &488 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &528 + commit: &540 title: Commit description: Commit type: object @@ -59763,7 +61077,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &464 + properties: &476 name: type: string example: '"Chris Wanstrath"' @@ -59778,7 +61092,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *464 + properties: *476 nullable: true message: type: string @@ -59799,7 +61113,7 @@ paths: required: - sha - url - verification: &589 + verification: &601 title: Verification type: object properties: @@ -59833,12 +61147,12 @@ paths: nullable: true oneOf: - *4 - - *235 + - *245 committer: nullable: true oneOf: - *4 - - *235 + - *245 parents: type: array items: @@ -59869,7 +61183,7 @@ paths: type: integer files: type: array - items: &543 + items: &555 title: Diff Entry description: Diff Entry type: object @@ -59952,7 +61266,7 @@ paths: - self protected: type: boolean - protection: *465 + protection: *477 protection_url: type: string format: uri @@ -60059,7 +61373,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *421 + '301': *433 '404': *6 x-github: githubCloudOnly: false @@ -60081,15 +61395,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *465 + schema: *477 examples: default: value: @@ -60283,9 +61597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -60540,7 +61854,7 @@ paths: url: type: string format: uri - required_status_checks: &473 + required_status_checks: &485 title: Status Check Policy description: Status Check Policy type: object @@ -60616,7 +61930,7 @@ paths: items: *4 teams: type: array - items: *255 + items: *265 apps: type: array items: *5 @@ -60634,7 +61948,7 @@ paths: items: *4 teams: type: array - items: *255 + items: *265 apps: type: array items: *5 @@ -60692,7 +62006,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *467 + restrictions: *479 required_conversation_resolution: type: object properties: @@ -60804,9 +62118,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -60831,17 +62145,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *468 + schema: *480 examples: - default: &469 + default: &481 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -60863,17 +62177,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *468 + schema: *480 examples: - default: *469 + default: *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60892,9 +62206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -60919,17 +62233,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *470 + schema: *482 examples: - default: &471 + default: &483 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -61025,9 +62339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -61125,9 +62439,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *482 examples: - default: *471 + default: *483 '422': *15 x-github: githubCloudOnly: false @@ -61148,9 +62462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -61177,17 +62491,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *468 + schema: *480 examples: - default: &472 + default: &484 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -61210,17 +62524,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *468 + schema: *480 examples: - default: *472 + default: *484 '404': *6 x-github: githubCloudOnly: false @@ -61240,9 +62554,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -61267,17 +62581,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *473 + schema: *485 examples: - default: &474 + default: &486 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -61303,9 +62617,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -61357,9 +62671,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *485 examples: - default: *474 + default: *486 '404': *6 '422': *15 x-github: @@ -61381,9 +62695,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -61407,9 +62721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response @@ -61443,9 +62757,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -61512,9 +62826,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -61578,9 +62892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: content: application/json: @@ -61646,15 +62960,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *467 + schema: *479 examples: default: value: @@ -61745,9 +63059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -61770,9 +63084,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response @@ -61782,7 +63096,7 @@ paths: type: array items: *5 examples: - default: &475 + default: &487 value: - id: 1 slug: octoapp @@ -61839,9 +63153,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -61875,7 +63189,7 @@ paths: type: array items: *5 examples: - default: *475 + default: *487 '422': *15 x-github: githubCloudOnly: false @@ -61896,9 +63210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -61932,7 +63246,7 @@ paths: type: array items: *5 examples: - default: *475 + default: *487 '422': *15 x-github: githubCloudOnly: false @@ -61953,9 +63267,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -61989,7 +63303,7 @@ paths: type: array items: *5 examples: - default: *475 + default: *487 '422': *15 x-github: githubCloudOnly: false @@ -62011,9 +63325,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response @@ -62021,9 +63335,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 '404': *6 x-github: githubCloudOnly: false @@ -62043,9 +63357,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -62081,9 +63395,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 '422': *15 x-github: githubCloudOnly: false @@ -62104,9 +63418,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -62142,9 +63456,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 '422': *15 x-github: githubCloudOnly: false @@ -62165,9 +63479,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: content: application/json: @@ -62202,9 +63516,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 '422': *15 x-github: githubCloudOnly: false @@ -62226,9 +63540,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response @@ -62238,7 +63552,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 '404': *6 x-github: githubCloudOnly: false @@ -62262,9 +63576,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -62297,7 +63611,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 '422': *15 x-github: githubCloudOnly: false @@ -62322,9 +63636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -62357,7 +63671,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 '422': *15 x-github: githubCloudOnly: false @@ -62382,9 +63696,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -62417,7 +63731,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 '422': *15 x-github: githubCloudOnly: false @@ -62444,9 +63758,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -62468,7 +63782,7 @@ paths: description: Response content: application/json: - schema: *476 + schema: *488 examples: default: value: @@ -62582,12 +63896,12 @@ paths: category: repos subcategory: bypass-requests parameters: - - *407 - - *408 - - *247 - - *248 - - *249 - - *250 + - *419 + - *420 + - *257 + - *258 + - *259 + - *260 - *17 - *19 responses: @@ -62597,11 +63911,11 @@ paths: application/json: schema: type: array - items: *251 + items: *261 examples: - default: *252 + default: *262 '404': *6 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": get: summary: Get a repository push bypass request @@ -62619,8 +63933,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: bypass_request_number in: path required: true @@ -62634,7 +63948,7 @@ paths: description: Response content: application/json: - schema: *251 + schema: *261 examples: default: value: @@ -62672,7 +63986,7 @@ paths: url: https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2 html_url: https://github.com/octo-org/smile/exemptions/2 '404': *6 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/bypass-requests/secret-scanning": get: summary: List bypass requests for secret scanning for a repository @@ -62693,12 +64007,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *407 - - *408 - - *247 - - *248 - - *249 - - *250 + - *419 + - *420 + - *257 + - *258 + - *259 + - *260 - *17 - *19 responses: @@ -62708,12 +64022,12 @@ paths: application/json: schema: type: array - items: *477 + items: *489 examples: - default: *478 + default: *490 '404': *6 '403': *29 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}": get: summary: Get a bypass request for secret scanning @@ -62734,8 +64048,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *407 - - *408 + - *419 + - *420 - name: bypass_request_number in: path required: true @@ -62747,7 +64061,7 @@ paths: description: A single bypass request. content: application/json: - schema: *477 + schema: *489 examples: default: value: @@ -62785,7 +64099,7 @@ paths: html_url: https://github.com/octo-org/smile/exemptions/1 '404': *6 '403': *29 - '500': *88 + '500': *90 patch: summary: Review a bypass request for secret scanning description: |- @@ -62805,8 +64119,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *407 - - *408 + - *419 + - *420 - name: bypass_request_number in: path required: true @@ -62856,7 +64170,7 @@ paths: '404': *6 '403': *29 '422': *15 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/bypass-responses/secret-scanning/{bypass_response_id}": delete: summary: Dismiss a response on a bypass request for secret scanning @@ -62877,8 +64191,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *407 - - *408 + - *419 + - *420 - name: bypass_response_id in: path required: true @@ -62891,7 +64205,7 @@ paths: '404': *6 '403': *29 '422': *15 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/check-runs": post: summary: Create a check run @@ -62911,8 +64225,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -63191,7 +64505,7 @@ paths: description: Response content: application/json: - schema: &480 + schema: &492 title: CheckRun description: A check performed on the code of a given code change type: object @@ -63302,16 +64616,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *479 - deployment: &806 + items: *491 + deployment: &818 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -63378,8 +64692,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 required: - id - node_id @@ -63591,9 +64905,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *407 - - *408 - - &481 + - *419 + - *420 + - &493 name: check_run_id description: The unique identifier of the check run. in: path @@ -63605,9 +64919,9 @@ paths: description: Response content: application/json: - schema: *480 + schema: *492 examples: - default: &482 + default: &494 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -63707,9 +65021,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *407 - - *408 - - *481 + - *419 + - *420 + - *493 requestBody: required: true content: @@ -63949,9 +65263,9 @@ paths: description: Response content: application/json: - schema: *480 + schema: *492 examples: - default: *482 + default: *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63971,9 +65285,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *407 - - *408 - - *481 + - *419 + - *420 + - *493 - *17 - *19 responses: @@ -64068,15 +65382,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *407 - - *408 - - *481 + - *419 + - *420 + - *493 responses: '201': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -64114,8 +65428,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -64137,7 +65451,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &485 + schema: &497 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -64201,7 +65515,7 @@ paths: nullable: true pull_requests: type: array - items: *479 + items: *491 nullable: true app: title: GitHub app @@ -64212,9 +65526,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 - repository: *224 + properties: *169 + required: *170 + repository: *234 created_at: type: string format: date-time @@ -64223,12 +65537,12 @@ paths: type: string format: date-time nullable: true - head_commit: &832 + head_commit: &844 title: Simple Commit description: A commit. type: object - properties: *483 - required: *484 + properties: *495 + required: *496 latest_check_runs_count: type: integer check_runs_url: @@ -64256,7 +65570,7 @@ paths: - check_runs_url - pull_requests examples: - default: &486 + default: &498 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -64547,9 +65861,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *485 + schema: *497 examples: - default: *486 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64568,8 +65882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -64630,7 +65944,7 @@ paths: required: - app_id - setting - repository: *224 + repository: *234 examples: default: value: @@ -64878,9 +66192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *407 - - *408 - - &487 + - *419 + - *420 + - &499 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -64892,9 +66206,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *497 examples: - default: *486 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64917,17 +66231,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *407 - - *408 - - *487 - - &536 + - *419 + - *420 + - *499 + - &548 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &537 + - &549 name: status description: Returns check runs with the specified `status`. in: query @@ -64966,9 +66280,9 @@ paths: type: integer check_runs: type: array - items: *480 + items: *492 examples: - default: &538 + default: &550 value: total_count: 1 check_runs: @@ -65070,15 +66384,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *407 - - *408 - - *487 + - *419 + - *420 + - *499 responses: '201': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -65105,30 +66419,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *407 - - *408 - - *259 - - *260 + - *419 + - *420 + - *269 + - *270 - *19 - *17 - - &503 + - &515 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *488 - - &504 + schema: *500 + - &516 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer + - *93 - *91 - - *89 - - *90 + - *92 - name: sort description: The property by which to sort the results. in: query @@ -65144,13 +66458,13 @@ paths: be returned. in: query required: false - schema: *261 + schema: *271 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *489 + schema: *501 responses: '200': description: Response @@ -65161,14 +66475,14 @@ paths: items: type: object properties: - number: *103 - created_at: *110 - updated_at: *111 - url: *108 - html_url: *109 - instances_url: *490 - state: *94 - fixed_at: *113 + number: *105 + created_at: *112 + updated_at: *113 + url: *110 + html_url: *111 + instances_url: *502 + state: *96 + fixed_at: *115 dismissed_by: title: Simple User description: A GitHub user. @@ -65176,12 +66490,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *112 - dismissed_reason: *491 - dismissed_comment: *492 - rule: *493 - tool: *494 - most_recent_instance: *495 + dismissed_at: *114 + dismissed_reason: *503 + dismissed_comment: *504 + rule: *505 + tool: *506 + most_recent_instance: *507 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -65304,14 +66618,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &496 + '403': &508 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65331,9 +66645,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *407 - - *408 - - &497 + - *419 + - *420 + - &509 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -65341,23 +66655,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *103 + schema: *105 responses: '200': description: Response content: application/json: - schema: &498 + schema: &510 type: object properties: - number: *103 - created_at: *110 - updated_at: *111 - url: *108 - html_url: *109 - instances_url: *490 - state: *94 - fixed_at: *113 + number: *105 + created_at: *112 + updated_at: *113 + url: *110 + html_url: *111 + instances_url: *502 + state: *96 + fixed_at: *115 dismissed_by: title: Simple User description: A GitHub user. @@ -65365,9 +66679,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *112 - dismissed_reason: *491 - dismissed_comment: *492 + dismissed_at: *114 + dismissed_reason: *503 + dismissed_comment: *504 rule: type: object properties: @@ -65421,8 +66735,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *494 - most_recent_instance: *495 + tool: *506 + most_recent_instance: *507 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -65518,9 +66832,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65538,9 +66852,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 requestBody: required: true content: @@ -65555,8 +66869,8 @@ paths: enum: - open - dismissed - dismissed_reason: *491 - dismissed_comment: *492 + dismissed_reason: *503 + dismissed_comment: *504 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -65575,7 +66889,7 @@ paths: description: Response content: application/json: - schema: *498 + schema: *510 examples: default: value: @@ -65651,14 +66965,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &502 + '403': &514 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -65678,15 +66992,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 responses: '200': description: Response content: application/json: - schema: &499 + schema: &511 type: object properties: status: @@ -65712,13 +67026,13 @@ paths: - description - started_at examples: - default: &500 + default: &512 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &501 + '400': &513 description: Bad Request content: application/json: @@ -65729,9 +67043,9 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65754,29 +67068,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 responses: '200': description: OK content: application/json: - schema: *499 + schema: *511 examples: - default: *500 + default: *512 '202': description: Accepted content: application/json: - schema: *499 + schema: *511 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *501 + '400': *513 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -65786,7 +67100,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65808,9 +67122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 requestBody: required: false content: @@ -65855,12 +67169,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *501 - '403': *502 + '400': *513 + '403': *514 '404': *6 '422': description: Unprocessable Entity - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65880,13 +67194,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 - *19 - *17 - - *503 - - *504 + - *515 + - *516 responses: '200': description: Response @@ -65894,7 +67208,7 @@ paths: application/json: schema: type: array - items: *495 + items: *507 examples: default: value: @@ -65933,9 +67247,9 @@ paths: end_column: 50 classifications: - source - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65967,29 +67281,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *407 - - *408 - - *259 - - *260 + - *419 + - *420 + - *269 + - *270 - *19 - *17 - - *504 + - *516 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *488 + schema: *500 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &507 + schema: &519 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *91 + - *93 - name: sort description: The property by which to sort the results. in: query @@ -66006,23 +67320,23 @@ paths: application/json: schema: type: array - items: &508 + items: &520 type: object properties: - ref: *488 - commit_sha: &516 + ref: *500 + commit_sha: &528 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *505 + analysis_key: *517 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *506 + category: *518 error: type: string example: error reading field xyz @@ -66046,8 +67360,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *507 - tool: *494 + sarif_id: *519 + tool: *506 deletable: type: boolean warning: @@ -66108,9 +67422,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -66144,8 +67458,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -66158,7 +67472,7 @@ paths: description: Response content: application/json: - schema: *508 + schema: *520 examples: response: summary: application/json response @@ -66212,14 +67526,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *496 + '403': *508 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -66299,8 +67613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -66353,9 +67667,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *502 + '403': *514 '404': *6 - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -66375,8 +67689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -66384,7 +67698,7 @@ paths: application/json: schema: type: array - items: &509 + items: &521 title: CodeQL Database description: A CodeQL database. type: object @@ -66495,9 +67809,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66524,8 +67838,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: language in: path description: The language of the CodeQL database. @@ -66537,7 +67851,7 @@ paths: description: Response content: application/json: - schema: *509 + schema: *521 examples: default: value: @@ -66569,11 +67883,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &545 + '302': &557 description: Found - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66593,8 +67907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *407 - - *408 + - *419 + - *420 - name: language in: path description: The language of the CodeQL database. @@ -66604,9 +67918,9 @@ paths: responses: '204': description: Response - '403': *502 + '403': *514 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66632,8 +67946,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -66642,7 +67956,7 @@ paths: type: object additionalProperties: false properties: - language: &510 + language: &522 type: string description: The language targeted by the CodeQL query enum: @@ -66721,7 +68035,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &514 + schema: &526 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -66729,9 +68043,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *100 + controller_repo: *102 actor: *4 - query_language: *510 + query_language: *522 query_pack_url: type: string description: The download url for the query pack. @@ -66778,7 +68092,7 @@ paths: items: type: object properties: - repository: &511 + repository: &523 title: Repository Identifier description: Repository Identifier type: object @@ -66814,7 +68128,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &515 + analysis_status: &527 type: string description: The new status of the CodeQL variant analysis repository task. @@ -66846,7 +68160,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &512 + access_mismatch_repos: &524 type: object properties: repository_count: @@ -66860,7 +68174,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *511 + items: *523 required: - repository_count - repositories @@ -66882,8 +68196,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *512 - over_limit_repos: *512 + no_codeql_db_repos: *524 + over_limit_repos: *524 required: - access_mismatch_repos - not_found_repos @@ -66899,7 +68213,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &513 + value: &525 summary: Default response value: id: 1 @@ -67051,17 +68365,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *513 + value: *525 repository_lists: summary: Response for a successful variant analysis submission - value: *513 + value: *525 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67082,8 +68396,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *407 - - *408 + - *419 + - *420 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -67095,11 +68409,11 @@ paths: description: Response content: application/json: - schema: *514 + schema: *526 examples: - default: *513 + default: *525 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67120,7 +68434,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *407 + - *419 - name: repo in: path description: The name of the controller repository. @@ -67154,8 +68468,8 @@ paths: schema: type: object properties: - repository: *100 - analysis_status: *515 + repository: *102 + analysis_status: *527 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -67259,7 +68573,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67280,8 +68594,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -67366,9 +68680,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67387,8 +68701,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -67455,7 +68769,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -67480,7 +68794,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *502 + '403': *514 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -67494,7 +68808,7 @@ paths: content: application/json: schema: *3 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67551,8 +68865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -67560,7 +68874,7 @@ paths: schema: type: object properties: - commit_sha: *516 + commit_sha: *528 ref: type: string description: |- @@ -67618,7 +68932,7 @@ paths: schema: type: object properties: - id: *507 + id: *519 url: type: string description: The REST API URL for checking the status of the upload. @@ -67632,11 +68946,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *502 + '403': *514 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -67655,8 +68969,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *407 - - *408 + - *419 + - *420 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -67702,10 +69016,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *496 + '403': *508 '404': description: Not Found if the sarif id does not match any upload - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -67727,8 +69041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -67752,7 +69066,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *95 + configuration: *97 examples: default: value: @@ -67784,7 +69098,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *123 + '204': *125 '304': *37 '403': *29 '404': *6 @@ -67809,8 +69123,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *407 - - *408 + - *419 + - *420 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -67930,8 +69244,8 @@ paths: parameters: - *17 - *19 - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -67947,7 +69261,7 @@ paths: type: integer codespaces: type: array - items: *322 + items: *332 examples: default: value: @@ -68223,7 +69537,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': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -68245,8 +69559,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -68309,22 +69623,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68348,8 +69662,8 @@ paths: parameters: - *17 - *19 - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -68389,7 +69703,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *88 + '500': *90 '400': *14 '401': *25 '403': *29 @@ -68413,8 +69727,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -68449,14 +69763,14 @@ paths: type: integer machines: type: array - items: &759 + items: &772 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *518 - required: *519 + properties: *530 + required: *531 examples: - default: &760 + default: &773 value: total_count: 2 machines: @@ -68473,7 +69787,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -68496,8 +69810,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *407 - - *408 + - *419 + - *420 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -68581,8 +69895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *407 - - *408 + - *419 + - *420 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -68627,7 +69941,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68648,8 +69962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -68667,7 +69981,7 @@ paths: type: integer secrets: type: array - items: &523 + items: &535 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -68687,7 +70001,7 @@ paths: - created_at - updated_at examples: - default: *520 + default: *532 headers: Link: *40 x-github: @@ -68710,16 +70024,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *521 + schema: *533 examples: - default: *522 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68739,17 +70053,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '200': description: Response content: application/json: - schema: *523 + schema: *535 examples: - default: *524 + default: *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68769,9 +70083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 requestBody: required: true content: @@ -68799,7 +70113,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -68823,9 +70137,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '204': description: Response @@ -68853,8 +70167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *407 - - *408 + - *419 + - *420 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -68896,7 +70210,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &525 + properties: &537 login: type: string example: octocat @@ -68989,7 +70303,7 @@ paths: user_view_type: type: string example: public - required: &526 + required: &538 - avatar_url - events_url - followers_url @@ -69063,9 +70377,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *407 - - *408 - - *246 + - *419 + - *420 + - *256 responses: '204': description: Response if user is a collaborator @@ -69111,9 +70425,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *407 - - *408 - - *246 + - *419 + - *420 + - *256 requestBody: required: false content: @@ -69139,7 +70453,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &602 + schema: &614 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -69150,7 +70464,7 @@ paths: example: 42 type: integer format: int64 - repository: *224 + repository: *234 invitee: title: Simple User description: A GitHub user. @@ -69328,7 +70642,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *207 + schema: *217 '403': *29 x-github: triggersNotification: true @@ -69368,9 +70682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *407 - - *408 - - *246 + - *419 + - *420 + - *256 responses: '204': description: No Content when collaborator was removed from the repository. @@ -69401,9 +70715,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *407 - - *408 - - *246 + - *419 + - *420 + - *256 responses: '200': description: if user has admin permissions @@ -69423,8 +70737,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *525 - required: *526 + properties: *537 + required: *538 nullable: true required: - permission @@ -69479,8 +70793,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -69490,7 +70804,7 @@ paths: application/json: schema: type: array - items: &527 + items: &539 title: Commit Comment description: Commit Comment type: object @@ -69531,8 +70845,8 @@ paths: updated_at: type: string format: date-time - author_association: *167 - reactions: *168 + author_association: *171 + reactions: *172 required: - url - html_url @@ -69548,7 +70862,7 @@ paths: - created_at - updated_at examples: - default: &530 + default: &542 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69607,17 +70921,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '200': description: Response content: application/json: - schema: *527 + schema: *539 examples: - default: &531 + default: &543 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69674,9 +70988,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -69698,7 +71012,7 @@ paths: description: Response content: application/json: - schema: *527 + schema: *539 examples: default: value: @@ -69749,9 +71063,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '204': description: Response @@ -69772,9 +71086,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -69800,9 +71114,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 '404': *6 @@ -69823,9 +71137,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -69857,16 +71171,16 @@ paths: description: Reaction exists content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Reaction created content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '422': *15 x-github: githubCloudOnly: false @@ -69888,10 +71202,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *407 - - *408 - - *179 - - *399 + - *419 + - *420 + - *183 + - *411 responses: '204': description: Response @@ -69940,8 +71254,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *407 - - *408 + - *419 + - *420 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -69997,9 +71311,9 @@ paths: application/json: schema: type: array - items: *528 + items: *540 examples: - default: &653 + default: &665 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -70070,10 +71384,10 @@ paths: sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: Link: *40 - '500': *88 + '500': *90 '400': *14 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70093,9 +71407,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *407 - - *408 - - &529 + - *419 + - *420 + - &541 name: commit_sha description: The SHA of the commit. in: path @@ -70142,7 +71456,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70167,9 +71481,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *407 - - *408 - - *529 + - *419 + - *420 + - *541 - *17 - *19 responses: @@ -70179,9 +71493,9 @@ paths: application/json: schema: type: array - items: *527 + items: *539 examples: - default: *530 + default: *542 headers: Link: *40 x-github: @@ -70209,9 +71523,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *407 - - *408 - - *529 + - *419 + - *420 + - *541 requestBody: required: true content: @@ -70246,9 +71560,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *539 examples: - default: *531 + default: *543 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -70276,9 +71590,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *407 - - *408 - - *529 + - *419 + - *420 + - *541 - *17 - *19 responses: @@ -70288,7 +71602,7 @@ paths: application/json: schema: type: array - items: &644 + items: &656 title: Pull Request Simple description: Pull Request Simple type: object @@ -70394,8 +71708,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *532 - required: *533 + properties: *544 + required: *545 nullable: true active_lock_reason: type: string @@ -70440,7 +71754,7 @@ paths: nullable: true requested_teams: type: array - items: *255 + items: *265 nullable: true head: type: object @@ -70449,7 +71763,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *66 sha: type: string user: @@ -70472,7 +71786,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *66 sha: type: string user: @@ -70491,7 +71805,7 @@ paths: _links: type: object properties: - comments: &534 + comments: &546 title: Link description: Hypermedia Link type: object @@ -70500,13 +71814,13 @@ paths: type: string required: - href - commits: *534 - statuses: *534 - html: *534 - issue: *534 - review_comments: *534 - review_comment: *534 - self: *534 + commits: *546 + statuses: *546 + html: *546 + issue: *546 + review_comments: *546 + review_comment: *546 + self: *546 required: - comments - commits @@ -70516,8 +71830,8 @@ paths: - review_comments - review_comment - self - author_association: *167 - auto_merge: &646 + author_association: *171 + auto_merge: &658 title: Auto merge description: The status of auto merging a pull request. type: object @@ -70580,7 +71894,7 @@ paths: - author_association - auto_merge examples: - default: &645 + default: &657 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -71060,7 +72374,7 @@ paths: draft: false headers: Link: *40 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71117,11 +72431,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *407 - - *408 + - *419 + - *420 - *19 - *17 - - &535 + - &547 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -71136,9 +72450,9 @@ paths: description: Response content: application/json: - schema: *528 + schema: *540 examples: - default: &631 + default: &643 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -71224,9 +72538,9 @@ paths: ..... '422': *15 '404': *6 - '500': *88 - '503': *157 - '409': *99 + '500': *90 + '503': *159 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71251,11 +72565,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *407 - - *408 - - *535 - - *536 - - *537 + - *419 + - *420 + - *547 + - *548 + - *549 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -71289,9 +72603,9 @@ paths: type: integer check_runs: type: array - items: *480 + items: *492 examples: - default: *538 + default: *550 headers: Link: *40 x-github: @@ -71316,9 +72630,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *407 - - *408 - - *535 + - *419 + - *420 + - *547 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -71326,7 +72640,7 @@ paths: schema: type: integer example: 1 - - *536 + - *548 - *17 - *19 responses: @@ -71344,7 +72658,7 @@ paths: type: integer check_suites: type: array - items: *485 + items: *497 examples: default: value: @@ -71544,9 +72858,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *407 - - *408 - - *535 + - *419 + - *420 + - *547 - *17 - *19 responses: @@ -71613,7 +72927,7 @@ paths: type: string total_count: type: integer - repository: *224 + repository: *234 commit_url: type: string format: uri @@ -71744,9 +73058,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *407 - - *408 - - *535 + - *419 + - *420 + - *547 - *17 - *19 responses: @@ -71756,7 +73070,7 @@ paths: application/json: schema: type: array - items: &706 + items: &718 title: Status description: The status of a commit. type: object @@ -71837,7 +73151,7 @@ paths: site_admin: false headers: Link: *40 - '301': *421 + '301': *433 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71865,8 +73179,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -71895,20 +73209,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *539 - required: *540 + properties: *551 + required: *552 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &541 + properties: &553 url: type: string format: uri html_url: type: string format: uri - required: &542 + required: &554 - url - html_url nullable: true @@ -71916,32 +73230,32 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true contributing: title: Community Health File type: object - properties: *541 - required: *542 + properties: *553 + required: *554 nullable: true readme: title: Community Health File type: object - properties: *541 - required: *542 + properties: *553 + required: *554 nullable: true issue_template: title: Community Health File type: object - properties: *541 - required: *542 + properties: *553 + required: *554 nullable: true pull_request_template: title: Community Health File type: object - properties: *541 - required: *542 + properties: *553 + required: *554 nullable: true required: - code_of_conduct @@ -72068,8 +73382,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *407 - - *408 + - *419 + - *420 - *19 - *17 - name: basehead @@ -72112,8 +73426,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *528 - merge_base_commit: *528 + base_commit: *540 + merge_base_commit: *540 status: type: string enum: @@ -72133,10 +73447,10 @@ paths: example: 6 commits: type: array - items: *528 + items: *540 files: type: array - items: *543 + items: *555 required: - url - html_url @@ -72379,8 +73693,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72422,8 +73736,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *407 - - *408 + - *419 + - *420 - name: path description: path parameter in: path @@ -72566,7 +73880,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &544 + response-if-content-is-a-file: &556 summary: Response if content is a file value: type: file @@ -72698,7 +74012,7 @@ paths: - size - type - url - - &658 + - &670 title: Content File description: Content File type: object @@ -72899,7 +74213,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *544 + response-if-content-is-a-file: *556 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -72968,7 +74282,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *545 + '302': *557 '304': *37 x-github: githubCloudOnly: false @@ -72991,8 +74305,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *407 - - *408 + - *419 + - *420 - name: path description: path parameter in: path @@ -73085,7 +74399,7 @@ paths: description: Response content: application/json: - schema: &546 + schema: &558 title: File Commit description: File Commit type: object @@ -73237,7 +74551,7 @@ paths: description: Response content: application/json: - schema: *546 + schema: *558 examples: example-for-creating-a-file: value: @@ -73291,7 +74605,7 @@ paths: schema: oneOf: - *3 - - &584 + - &596 description: Repository rule violation was detected type: object properties: @@ -73312,7 +74626,7 @@ paths: items: type: object properties: - placeholder_id: &698 + placeholder_id: &710 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -73344,8 +74658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *407 - - *408 + - *419 + - *420 - name: path description: path parameter in: path @@ -73406,7 +74720,7 @@ paths: description: Response content: application/json: - schema: *546 + schema: *558 examples: default: value: @@ -73440,8 +74754,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *99 - '503': *157 + '409': *101 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73461,8 +74775,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *407 - - *408 + - *419 + - *420 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -73585,23 +74899,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *407 - - *408 - - *276 - - *277 - - *278 - - *279 + - *419 + - *420 + - *286 + - *287 + - *288 + - *289 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *280 - - *281 - - *282 - - *283 - - *91 + - *290 + - *291 + - *292 + - *293 + - *93 - name: page description: "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead." @@ -73618,10 +74932,10 @@ paths: schema: type: integer default: 30 - - *89 - - *90 - - *284 - - *285 + - *91 + - *92 + - *294 + - *295 responses: '200': description: Response @@ -73629,11 +74943,11 @@ paths: application/json: schema: type: array - items: &549 + items: &561 type: object description: A Dependabot alert. properties: - number: *103 + number: *105 state: type: string description: The state of the Dependabot alert. @@ -73648,7 +74962,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *104 + package: *106 manifest_path: type: string description: The full path to the dependency manifest file, @@ -73675,13 +74989,13 @@ paths: - unknown - direct - transitive - security_advisory: *547 - security_vulnerability: *107 - url: *108 - html_url: *109 - created_at: *110 - updated_at: *111 - dismissed_at: *112 + security_advisory: *559 + security_vulnerability: *109 + url: *110 + html_url: *111 + created_at: *112 + updated_at: *113 + dismissed_at: *114 dismissed_by: title: Simple User description: A GitHub user. @@ -73705,8 +75019,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *113 - auto_dismissed_at: *548 + fixed_at: *115 + auto_dismissed_at: *560 required: - number - state @@ -73936,9 +75250,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *407 - - *408 - - &550 + - *419 + - *420 + - &562 name: alert_number in: path description: |- @@ -73947,13 +75261,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *103 + schema: *105 responses: '200': description: Response content: application/json: - schema: *549 + schema: *561 examples: default: value: @@ -74066,9 +75380,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *407 - - *408 - - *550 + - *419 + - *420 + - *562 requestBody: required: true content: @@ -74113,7 +75427,7 @@ paths: description: Response content: application/json: - schema: *549 + schema: *561 examples: default: value: @@ -74219,7 +75533,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *99 + '409': *101 '422': *7 x-github: githubCloudOnly: false @@ -74242,8 +75556,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -74261,7 +75575,7 @@ paths: type: integer secrets: type: array - items: &553 + items: &565 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -74314,16 +75628,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *551 + schema: *563 examples: - default: *552 + default: *564 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74343,15 +75657,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '200': description: Response content: application/json: - schema: *553 + schema: *565 examples: default: value: @@ -74377,9 +75691,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 requestBody: required: true content: @@ -74407,7 +75721,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -74431,9 +75745,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '204': description: Response @@ -74455,8 +75769,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *407 - - *408 + - *419 + - *420 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -74616,8 +75930,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -74856,8 +76170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -74932,7 +76246,7 @@ paths: - version - url additionalProperties: false - metadata: &554 + metadata: &566 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -74965,7 +76279,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *554 + metadata: *566 resolved: type: object description: A collection of resolved package dependencies. @@ -74978,7 +76292,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *554 + metadata: *566 relationship: type: string description: A notation of whether a dependency is requested @@ -75107,8 +76421,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *407 - - *408 + - *419 + - *420 - name: sha description: The SHA recorded at creation time. in: query @@ -75148,9 +76462,9 @@ paths: application/json: schema: type: array - items: *555 + items: *567 examples: - default: *556 + default: *568 headers: Link: *40 x-github: @@ -75216,8 +76530,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -75298,7 +76612,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *567 examples: simple-example: summary: Simple example @@ -75371,9 +76685,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *407 - - *408 - - &557 + - *419 + - *420 + - &569 name: deployment_id description: deployment_id parameter in: path @@ -75385,7 +76699,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *567 examples: default: value: @@ -75450,9 +76764,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *407 - - *408 - - *557 + - *419 + - *420 + - *569 responses: '204': description: Response @@ -75474,9 +76788,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *407 - - *408 - - *557 + - *419 + - *420 + - *569 - *17 - *19 responses: @@ -75486,7 +76800,7 @@ paths: application/json: schema: type: array - items: &558 + items: &570 title: Deployment Status description: The status of a deployment. type: object @@ -75577,8 +76891,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 required: - id - node_id @@ -75647,9 +76961,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *407 - - *408 - - *557 + - *419 + - *420 + - *569 requestBody: required: true content: @@ -75724,9 +77038,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *570 examples: - default: &559 + default: &571 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -75782,9 +77096,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *407 - - *408 - - *557 + - *419 + - *420 + - *569 - name: status_id in: path required: true @@ -75795,9 +77109,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *570 examples: - default: *559 + default: *571 '404': *6 x-github: githubCloudOnly: false @@ -75824,12 +77138,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 - - *560 - - *561 - - *562 - - *563 + - *419 + - *420 + - *572 + - *573 + - *574 + - *575 - *17 - *19 responses: @@ -75839,12 +77153,12 @@ paths: application/json: schema: type: array - items: *564 + items: *576 examples: - default: *565 + default: *577 '404': *6 '403': *29 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}": get: summary: Get a dismissal request for a code scanning alert for a repository @@ -75865,8 +77179,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: alert_number in: path required: true @@ -75878,7 +77192,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *564 + schema: *576 examples: default: value: @@ -75914,7 +77228,7 @@ paths: html_url: https://github.com/octo-org/smile/code-scanning/alerts/1 '404': *6 '403': *29 - '500': *88 + '500': *90 patch: summary: Review a dismissal request for a code scanning alert for a repository description: |- @@ -75934,8 +77248,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: alert_number in: path required: true @@ -75973,7 +77287,7 @@ paths: '404': *6 '403': *29 '422': *15 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/dismissal-requests/secret-scanning": get: summary: List alert dismissal requests for secret scanning for a repository @@ -75994,12 +77308,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 - - *247 - - *248 - - *249 - - *566 + - *419 + - *420 + - *257 + - *258 + - *259 + - *578 - *17 - *19 responses: @@ -76009,12 +77323,12 @@ paths: application/json: schema: type: array - items: *567 + items: *579 examples: - default: *568 + default: *580 '404': *6 '403': *29 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}": get: summary: Get an alert dismissal request for secret scanning @@ -76036,8 +77350,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: alert_number in: path required: true @@ -76049,7 +77363,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *567 + schema: *579 examples: default: value: @@ -76086,7 +77400,7 @@ paths: html_url: https://github.com/octo-org/smile/security/secret-scanning/17 '404': *6 '403': *29 - '500': *88 + '500': *90 patch: summary: Review an alert dismissal request for secret scanning description: |- @@ -76107,8 +77421,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: alert_number in: path required: true @@ -76158,7 +77472,7 @@ paths: '404': *6 '403': *29 '422': *15 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/dispatches": post: summary: Create a repository dispatch event @@ -76177,8 +77491,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -76235,8 +77549,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -76253,7 +77567,7 @@ paths: type: integer environments: type: array - items: &570 + items: &582 title: Environment description: Details of a deployment environment type: object @@ -76305,7 +77619,7 @@ paths: type: type: string example: wait_timer - wait_timer: &572 + wait_timer: &584 type: integer example: 30 description: The amount of time to delay a job after @@ -76342,11 +77656,11 @@ paths: items: type: object properties: - type: *569 + type: *581 reviewer: anyOf: - *4 - - *255 + - *265 required: - id - node_id @@ -76366,7 +77680,7 @@ paths: - id - node_id - type - deployment_branch_policy: &573 + deployment_branch_policy: &585 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -76482,9 +77796,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *407 - - *408 - - &571 + - *419 + - *420 + - &583 name: environment_name in: path required: true @@ -76497,9 +77811,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *582 examples: - default: &574 + default: &586 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -76583,9 +77897,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 requestBody: required: false content: @@ -76594,7 +77908,7 @@ paths: type: object nullable: true properties: - wait_timer: *572 + wait_timer: *584 prevent_self_review: type: boolean example: false @@ -76611,13 +77925,13 @@ paths: items: type: object properties: - type: *569 + type: *581 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *573 + deployment_branch_policy: *585 additionalProperties: false examples: default: @@ -76637,9 +77951,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *582 examples: - default: *574 + default: *586 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -76663,9 +77977,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 responses: '204': description: Default response @@ -76690,9 +78004,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 - *17 - *19 responses: @@ -76710,7 +78024,7 @@ paths: example: 2 branch_policies: type: array - items: &575 + items: &587 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -76767,9 +78081,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 requestBody: required: true content: @@ -76815,9 +78129,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *587 examples: - example-wildcard: &576 + example-wildcard: &588 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -76859,10 +78173,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *407 - - *408 - - *571 - - &577 + - *419 + - *420 + - *583 + - &589 name: branch_policy_id in: path required: true @@ -76874,9 +78188,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *587 examples: - default: *576 + default: *588 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76895,10 +78209,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *407 - - *408 - - *571 - - *577 + - *419 + - *420 + - *583 + - *589 requestBody: required: true content: @@ -76926,9 +78240,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *587 examples: - default: *576 + default: *588 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76947,10 +78261,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *407 - - *408 - - *571 - - *577 + - *419 + - *420 + - *583 + - *589 responses: '204': description: Response @@ -76975,9 +78289,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *571 - - *408 - - *407 + - *583 + - *420 + - *419 responses: '200': description: List of deployment protection rules @@ -76993,7 +78307,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &578 + items: &590 title: Deployment protection rule description: Deployment protection rule type: object @@ -77012,7 +78326,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &579 + app: &591 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -77111,9 +78425,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *571 - - *408 - - *407 + - *583 + - *420 + - *419 requestBody: content: application/json: @@ -77134,9 +78448,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *578 + schema: *590 examples: - default: &580 + default: &592 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -77171,9 +78485,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *571 - - *408 - - *407 + - *583 + - *420 + - *419 - *19 - *17 responses: @@ -77192,7 +78506,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *579 + items: *591 examples: default: value: @@ -77227,10 +78541,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *407 - - *408 - - *571 - - &581 + - *419 + - *420 + - *583 + - &593 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -77242,9 +78556,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *590 examples: - default: *580 + default: *592 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77265,10 +78579,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *571 - - *408 - - *407 - - *581 + - *583 + - *420 + - *419 + - *593 responses: '204': description: Response @@ -77294,9 +78608,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 - *17 - *19 responses: @@ -77314,9 +78628,9 @@ paths: type: integer secrets: type: array - items: *444 + items: *456 examples: - default: *445 + default: *457 headers: Link: *40 x-github: @@ -77341,17 +78655,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 responses: '200': description: Response content: application/json: - schema: *446 + schema: *458 examples: - default: *447 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77373,18 +78687,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *407 - - *408 - - *571 - - *234 + - *419 + - *420 + - *583 + - *244 responses: '200': description: Response content: application/json: - schema: *444 + schema: *456 examples: - default: *582 + default: *594 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77406,10 +78720,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *407 - - *408 - - *571 - - *234 + - *419 + - *420 + - *583 + - *244 requestBody: required: true content: @@ -77440,7 +78754,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -77466,10 +78780,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *407 - - *408 - - *571 - - *234 + - *419 + - *420 + - *583 + - *244 responses: '204': description: Default response @@ -77494,10 +78808,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *407 - - *408 - - *571 - - *431 + - *419 + - *420 + - *583 + - *443 - *19 responses: '200': @@ -77514,9 +78828,9 @@ paths: type: integer variables: type: array - items: *448 + items: *460 examples: - default: *449 + default: *461 headers: Link: *40 x-github: @@ -77539,9 +78853,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 requestBody: required: true content: @@ -77568,7 +78882,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -77593,18 +78907,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *407 - - *408 - - *571 - - *237 + - *419 + - *420 + - *583 + - *247 responses: '200': description: Response content: application/json: - schema: *448 + schema: *460 examples: - default: *583 + default: *595 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77625,10 +78939,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *407 - - *408 - - *237 - - *571 + - *419 + - *420 + - *247 + - *583 requestBody: required: true content: @@ -77670,10 +78984,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *407 - - *408 - - *237 - - *571 + - *419 + - *420 + - *247 + - *583 responses: '204': description: Response @@ -77695,8 +79009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -77706,7 +79020,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: 200-response: value: @@ -77773,8 +79087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *407 - - *408 + - *419 + - *420 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -77796,7 +79110,7 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: default: value: @@ -77933,8 +79247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -77966,9 +79280,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *432 examples: - default: *422 + default: *434 '400': *14 '422': *15 '403': *29 @@ -77989,8 +79303,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -78041,7 +79355,7 @@ paths: schema: type: string '404': *6 - '409': *99 + '409': *101 '403': *29 '422': description: Validation failed @@ -78049,8 +79363,8 @@ paths: application/json: schema: oneOf: - - *207 - - *584 + - *217 + - *596 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78075,8 +79389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *407 - - *408 + - *419 + - *420 - name: file_sha in: path required: true @@ -78127,7 +79441,7 @@ paths: '404': *6 '422': *15 '403': *29 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78175,8 +79489,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -78285,7 +79599,7 @@ paths: description: Response content: application/json: - schema: &585 + schema: &597 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -78449,7 +79763,7 @@ paths: type: string '422': *15 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78499,15 +79813,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *407 - - *408 - - *529 + - *419 + - *420 + - *541 responses: '200': description: Response content: application/json: - schema: *585 + schema: *597 examples: default: value: @@ -78538,7 +79852,7 @@ paths: payload: verified_at: '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78563,9 +79877,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *407 - - *408 - - &586 + - *419 + - *420 + - &598 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -78582,7 +79896,7 @@ paths: application/json: schema: type: array - items: &587 + items: &599 title: Git Reference description: Git references within a repository type: object @@ -78636,7 +79950,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *40 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78657,17 +79971,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *407 - - *408 - - *586 + - *419 + - *420 + - *598 responses: '200': description: Response content: application/json: - schema: *587 + schema: *599 examples: - default: &588 + default: &600 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -78677,7 +79991,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78696,8 +80010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -78726,16 +80040,16 @@ paths: description: Response content: application/json: - schema: *587 + schema: *599 examples: - default: *588 + default: *600 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78754,9 +80068,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *407 - - *408 - - *586 + - *419 + - *420 + - *598 requestBody: required: true content: @@ -78785,11 +80099,11 @@ paths: description: Response content: application/json: - schema: *587 + schema: *599 examples: - default: *588 + default: *600 '422': *15 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78805,16 +80119,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *407 - - *408 - - *586 + - *419 + - *420 + - *598 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78862,8 +80176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -78930,7 +80244,7 @@ paths: description: Response content: application/json: - schema: &590 + schema: &602 title: Git Tag description: Metadata for a Git tag type: object @@ -78981,7 +80295,7 @@ paths: - sha - type - url - verification: *589 + verification: *601 required: - sha - url @@ -78991,7 +80305,7 @@ paths: - tag - message examples: - default: &591 + default: &603 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -79018,7 +80332,7 @@ paths: schema: type: string '422': *15 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79064,8 +80378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *407 - - *408 + - *419 + - *420 - name: tag_sha in: path required: true @@ -79076,11 +80390,11 @@ paths: description: Response content: application/json: - schema: *590 + schema: *602 examples: - default: *591 + default: *603 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79102,8 +80416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -79176,7 +80490,7 @@ paths: description: Response content: application/json: - schema: &592 + schema: &604 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -79249,7 +80563,7 @@ paths: '422': *15 '404': *6 '403': *29 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79272,8 +80586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *407 - - *408 + - *419 + - *420 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -79296,7 +80610,7 @@ paths: description: Response content: application/json: - schema: *592 + schema: *604 examples: default-response: summary: Default response @@ -79337,7 +80651,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79355,8 +80669,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -79366,7 +80680,7 @@ paths: application/json: schema: type: array - items: &593 + items: &605 title: Webhook description: Webhooks for repositories. type: object @@ -79420,7 +80734,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &840 + last_response: &852 title: Hook Response type: object properties: @@ -79494,8 +80808,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -79547,9 +80861,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *605 examples: - default: &594 + default: &606 value: type: Repository id: 12345678 @@ -79597,17 +80911,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 responses: '200': description: Response content: application/json: - schema: *593 + schema: *605 examples: - default: *594 + default: *606 '404': *6 x-github: githubCloudOnly: false @@ -79627,9 +80941,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 requestBody: required: true content: @@ -79674,9 +80988,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *605 examples: - default: *594 + default: *606 '422': *15 '404': *6 x-github: @@ -79697,9 +81011,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 responses: '204': description: Response @@ -79723,9 +81037,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 responses: '200': description: Response @@ -79752,9 +81066,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 requestBody: required: false content: @@ -79798,11 +81112,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 - *17 - - *294 + - *304 responses: '200': description: Response @@ -79810,9 +81124,9 @@ paths: application/json: schema: type: array - items: *295 + items: *305 examples: - default: *296 + default: *306 '400': *14 '422': *15 x-github: @@ -79831,18 +81145,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 - *16 responses: '200': description: Response content: application/json: - schema: *297 + schema: *307 examples: - default: *298 + default: *308 '400': *14 '422': *15 x-github: @@ -79861,9 +81175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 - *16 responses: '202': *39 @@ -79886,9 +81200,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 responses: '204': description: Response @@ -79913,9 +81227,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 responses: '204': description: Response @@ -79973,14 +81287,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: &595 + schema: &607 title: Import description: A repository import from an external source. type: object @@ -80079,7 +81393,7 @@ paths: - html_url - authors_url examples: - default: &598 + default: &610 value: vcs: subversion use_lfs: true @@ -80095,7 +81409,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &596 + '503': &608 description: Unavailable due to service under maintenance. content: application/json: @@ -80124,8 +81438,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -80173,7 +81487,7 @@ paths: description: Response content: application/json: - schema: *595 + schema: *607 examples: default: value: @@ -80198,7 +81512,7 @@ paths: type: string '422': *15 '404': *6 - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80226,8 +81540,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -80276,7 +81590,7 @@ paths: description: Response content: application/json: - schema: *595 + schema: *607 examples: example-1: summary: Example 1 @@ -80324,7 +81638,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80347,12 +81661,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80378,9 +81692,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *407 - - *408 - - &783 + - *419 + - *420 + - &795 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -80394,7 +81708,7 @@ paths: application/json: schema: type: array - items: &597 + items: &609 title: Porter Author description: Porter Author type: object @@ -80448,7 +81762,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80473,8 +81787,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *407 - - *408 + - *419 + - *420 - name: author_id in: path required: true @@ -80504,7 +81818,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *609 examples: default: value: @@ -80517,7 +81831,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80541,8 +81855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -80583,7 +81897,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80611,8 +81925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -80639,11 +81953,11 @@ paths: description: Response content: application/json: - schema: *595 + schema: *607 examples: - default: *598 + default: *610 '422': *15 - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80666,8 +81980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -80675,8 +81989,8 @@ paths: application/json: schema: *22 examples: - default: *599 - '301': *421 + default: *611 + '301': *433 '404': *6 x-github: githubCloudOnly: false @@ -80696,8 +82010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -80705,12 +82019,12 @@ paths: application/json: schema: anyOf: - - *311 + - *321 - type: object properties: {} additionalProperties: false examples: - default: &601 + default: &613 value: limit: collaborators_only origin: repository @@ -80735,13 +82049,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: application/json: - schema: *600 + schema: *612 examples: default: summary: Example request body @@ -80753,9 +82067,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *321 examples: - default: *601 + default: *613 '409': description: Response x-github: @@ -80777,8 +82091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -80801,8 +82115,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -80812,9 +82126,9 @@ paths: application/json: schema: type: array - items: *602 + items: *614 examples: - default: &776 + default: &788 value: - id: 1 repository: @@ -80945,9 +82259,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *407 - - *408 - - *315 + - *419 + - *420 + - *325 requestBody: required: false content: @@ -80976,7 +82290,7 @@ paths: description: Response content: application/json: - schema: *602 + schema: *614 examples: default: value: @@ -81107,9 +82421,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *407 - - *408 - - *315 + - *419 + - *420 + - *325 responses: '204': description: Response @@ -81140,8 +82454,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *407 - - *408 + - *419 + - *420 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -81189,7 +82503,7 @@ paths: required: false schema: type: string - - *319 + - *329 - name: sort description: What to sort results by. in: query @@ -81201,8 +82515,8 @@ paths: - updated - comments default: created - - *91 - - *170 + - *93 + - *174 - *17 - *19 responses: @@ -81212,9 +82526,9 @@ paths: application/json: schema: type: array - items: *180 + items: *184 examples: - default: &613 + default: &623 value: - id: 1 node_id: MDU6SXNzdWUx @@ -81362,7 +82676,7 @@ paths: state_reason: completed headers: Link: *40 - '301': *421 + '301': *433 '422': *15 '404': *6 x-github: @@ -81391,8 +82705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -81474,9 +82788,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: &608 + default: &620 value: id: 1 node_id: MDU6SXNzdWUx @@ -81630,9 +82944,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *157 + '503': *159 '404': *6 - '410': *418 + '410': *430 x-github: triggersNotification: true githubCloudOnly: false @@ -81660,9 +82974,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *407 - - *408 - - *190 + - *419 + - *420 + - *194 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -81672,7 +82986,7 @@ paths: enum: - asc - desc - - *170 + - *174 - *17 - *19 responses: @@ -81682,9 +82996,9 @@ paths: application/json: schema: type: array - items: *603 + items: *615 examples: - default: &610 + default: &622 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -81742,17 +83056,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '200': description: Response content: application/json: - schema: *603 + schema: *615 examples: - default: &604 + default: &616 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -81806,9 +83120,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -81830,9 +83144,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *615 examples: - default: *604 + default: *616 '422': *15 x-github: githubCloudOnly: false @@ -81850,9 +83164,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '204': description: Response @@ -81872,9 +83186,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -81900,9 +83214,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 '404': *6 @@ -81923,9 +83237,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -81957,16 +83271,16 @@ paths: description: Reaction exists content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Reaction created content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '422': *15 x-github: githubCloudOnly: false @@ -81988,10 +83302,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *407 - - *408 - - *179 - - *399 + - *419 + - *420 + - *183 + - *411 responses: '204': description: Response @@ -82011,8 +83325,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -82022,7 +83336,7 @@ paths: application/json: schema: type: array - items: &607 + items: &619 title: Issue Event description: Issue Event type: object @@ -82065,8 +83379,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *605 - required: *606 + properties: *617 + required: *618 nullable: true label: title: Issue Event Label @@ -82110,7 +83424,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *255 + requested_team: *265 dismissed_review: title: Issue Event Dismissed Review type: object @@ -82175,7 +83489,7 @@ paths: required: - from - to - author_association: *167 + author_association: *171 lock_reason: type: string nullable: true @@ -82188,8 +83502,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 required: - id - node_id @@ -82373,8 +83687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *407 - - *408 + - *419 + - *420 - name: event_id in: path required: true @@ -82385,7 +83699,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *619 examples: default: value: @@ -82578,7 +83892,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *418 + '410': *430 '403': *29 x-github: githubCloudOnly: false @@ -82612,9 +83926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *407 - - *408 - - &609 + - *419 + - *420 + - &621 name: issue_number description: The number that identifies the issue. in: path @@ -82626,12 +83940,12 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 - '301': *421 + default: *620 + '301': *433 '404': *6 - '410': *418 + '410': *430 '304': *37 x-github: githubCloudOnly: false @@ -82656,9 +83970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: false content: @@ -82762,15 +84076,15 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 '422': *15 - '503': *157 + '503': *159 '403': *29 - '301': *421 + '301': *433 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82788,9 +84102,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: false content: @@ -82816,9 +84130,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82834,9 +84148,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: content: application/json: @@ -82861,9 +84175,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82885,9 +84199,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - name: assignee in: path required: true @@ -82927,10 +84241,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *407 - - *408 - - *609 - - *170 + - *419 + - *420 + - *621 + - *174 - *17 - *19 responses: @@ -82940,13 +84254,13 @@ paths: application/json: schema: type: array - items: *603 + items: *615 examples: - default: *610 + default: *622 headers: Link: *40 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82975,9 +84289,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: true content: @@ -82999,16 +84313,16 @@ paths: description: Response content: application/json: - schema: *603 + schema: *615 examples: - default: *604 + default: *616 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *418 + '410': *430 '422': *15 '404': *6 x-github: @@ -83017,6 +84331,210 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": + get: + summary: List dependencies an issue is blocked by + description: |- + You can use the REST API to list the dependencies an issue is blocked by. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - *419 + - *420 + - *621 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *184 + examples: + default: *623 + headers: + Link: *40 + '301': *433 + '404': *6 + '410': *430 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + post: + summary: Add a dependency an issue is blocked by + description: |- + You can use the REST API to add a 'blocked by' relationship to an issue. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - *419 + - *420 + - *621 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: *184 + examples: + default: *620 + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': *433 + '403': *29 + '410': *430 + '422': *15 + '404': *6 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": + delete: + summary: Remove dependency an issue is blocked by + description: |- + You can use the REST API to remove a dependency that an issue is blocked by. + + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - *419 + - *420 + - *621 + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *184 + examples: + default: *620 + '301': *433 + '400': *14 + '401': *25 + '403': *29 + '404': *6 + '410': *430 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": + get: + summary: List dependencies an issue is blocking + description: |- + You can use the REST API to list the dependencies an issue is blocking. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - *419 + - *420 + - *621 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *184 + examples: + default: *623 + headers: + Link: *40 + '301': *433 + '404': *6 + '410': *430 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events @@ -83028,9 +84546,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - *17 - *19 responses: @@ -83044,7 +84562,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &614 + - &626 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -83075,8 +84593,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 label: type: object properties: @@ -83098,7 +84616,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &615 + - &627 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -83129,8 +84647,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 label: type: object properties: @@ -83218,8 +84736,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 assignee: *4 assigner: *4 required: @@ -83234,7 +84752,7 @@ paths: - performed_via_github_app - assignee - assigner - - &616 + - &628 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -83265,8 +84783,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 milestone: type: object properties: @@ -83285,7 +84803,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &617 + - &629 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -83316,8 +84834,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 milestone: type: object properties: @@ -83336,7 +84854,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &618 + - &630 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -83367,8 +84885,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 rename: type: object properties: @@ -83390,7 +84908,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &619 + - &631 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -83421,10 +84939,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 review_requester: *4 - requested_team: *255 + requested_team: *265 requested_reviewer: *4 required: - review_requester @@ -83437,7 +84955,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &620 + - &632 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -83468,10 +84986,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 review_requester: *4 - requested_team: *255 + requested_team: *265 requested_reviewer: *4 required: - review_requester @@ -83484,7 +85002,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &621 + - &633 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -83515,8 +85033,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 dismissed_review: type: object properties: @@ -83544,7 +85062,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &622 + - &634 title: Locked Issue Event description: Locked Issue Event type: object @@ -83575,8 +85093,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 lock_reason: type: string example: '"off-topic"' @@ -83592,7 +85110,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &623 + - &635 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -83623,8 +85141,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 project_card: type: object properties: @@ -83658,7 +85176,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &624 + - &636 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -83689,8 +85207,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 project_card: type: object properties: @@ -83724,7 +85242,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &625 + - &637 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -83755,8 +85273,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 project_card: type: object properties: @@ -83790,7 +85308,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &626 + - &638 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -83881,7 +85399,7 @@ paths: color: red headers: Link: *40 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83898,9 +85416,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - *17 - *19 responses: @@ -83910,7 +85428,7 @@ paths: application/json: schema: type: array - items: &611 + items: &624 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -83957,7 +85475,7 @@ paths: - color - default examples: - default: &612 + default: &625 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -83975,9 +85493,9 @@ paths: default: false headers: Link: *40 - '301': *421 + '301': *433 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83994,9 +85512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: false content: @@ -84055,12 +85573,12 @@ paths: application/json: schema: type: array - items: *611 + items: *624 examples: - default: *612 - '301': *421 + default: *625 + '301': *433 '404': *6 - '410': *418 + '410': *430 '422': *15 x-github: githubCloudOnly: false @@ -84077,9 +85595,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: false content: @@ -84139,12 +85657,12 @@ paths: application/json: schema: type: array - items: *611 + items: *624 examples: - default: *612 - '301': *421 + default: *625 + '301': *433 '404': *6 - '410': *418 + '410': *430 '422': *15 x-github: githubCloudOnly: false @@ -84161,15 +85679,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 responses: '204': description: Response - '301': *421 + '301': *433 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84188,9 +85706,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - name: name in: path required: true @@ -84203,7 +85721,7 @@ paths: application/json: schema: type: array - items: *611 + items: *624 examples: default: value: @@ -84214,9 +85732,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *421 + '301': *433 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84236,9 +85754,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: false content: @@ -84266,7 +85784,7 @@ paths: '204': description: Response '403': *29 - '410': *418 + '410': *430 '404': *6 '422': *15 x-github: @@ -84284,9 +85802,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 responses: '204': description: Response @@ -84308,9 +85826,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -84336,13 +85854,13 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84360,9 +85878,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: true content: @@ -84394,16 +85912,16 @@ paths: description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '422': *15 x-github: githubCloudOnly: false @@ -84425,10 +85943,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *407 - - *408 - - *609 - - *399 + - *419 + - *420 + - *621 + - *411 responses: '204': description: Response @@ -84457,9 +85975,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: true content: @@ -84481,9 +85999,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -84516,9 +86034,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - *17 - *19 responses: @@ -84528,13 +86046,13 @@ paths: application/json: schema: type: array - items: *180 + items: *184 examples: - default: *613 + default: *623 headers: Link: *40 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84562,9 +86080,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: true content: @@ -84591,16 +86109,16 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *418 + '410': *430 '422': *15 '404': *6 x-github: @@ -84620,9 +86138,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: true content: @@ -84653,13 +86171,13 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 '403': *29 '404': *6 '422': *7 - '503': *157 + '503': *159 x-github: triggersNotification: true githubCloudOnly: false @@ -84677,9 +86195,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - *17 - *19 responses: @@ -84694,19 +86212,19 @@ paths: description: Timeline Event type: object anyOf: - - *614 - - *615 - - *616 - - *617 - - *618 - - *619 - - *620 - - *621 - - *622 - - *623 - - *624 - - *625 - *626 + - *627 + - *628 + - *629 + - *630 + - *631 + - *632 + - *633 + - *634 + - *635 + - *636 + - *637 + - *638 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -84749,7 +86267,7 @@ paths: issue_url: type: string format: uri - author_association: *167 + author_association: *171 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -84759,9 +86277,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 - reactions: *168 + properties: *169 + required: *170 + reactions: *172 required: - event - actor @@ -84792,7 +86310,7 @@ paths: properties: type: type: string - issue: *180 + issue: *184 required: - event - created_at @@ -84988,7 +86506,7 @@ paths: type: string body_text: type: string - author_association: *167 + author_association: *171 required: - event - id @@ -85011,7 +86529,7 @@ paths: type: string comments: type: array - items: &647 + items: &659 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -85100,7 +86618,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *167 + author_association: *171 _links: type: object properties: @@ -85184,7 +86702,7 @@ paths: enum: - line - file - reactions: *168 + reactions: *172 body_html: type: string example: '"

comment body

"' @@ -85220,7 +86738,7 @@ paths: type: string comments: type: array - items: *527 + items: *539 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -85251,8 +86769,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 assignee: *4 required: - id @@ -85295,8 +86813,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 assignee: *4 required: - id @@ -85339,8 +86857,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 state_reason: type: string nullable: true @@ -85509,7 +87027,7 @@ paths: headers: Link: *40 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85526,8 +87044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -85537,7 +87055,7 @@ paths: application/json: schema: type: array - items: &627 + items: &639 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -85603,8 +87121,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -85640,9 +87158,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *639 examples: - default: &628 + default: &640 value: id: 1 key: ssh-rsa AAA... @@ -85676,9 +87194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *407 - - *408 - - &629 + - *419 + - *420 + - &641 name: key_id description: The unique identifier of the key. in: path @@ -85690,9 +87208,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *639 examples: - default: *628 + default: *640 '404': *6 x-github: githubCloudOnly: false @@ -85710,9 +87228,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *407 - - *408 - - *629 + - *419 + - *420 + - *641 responses: '204': description: Response @@ -85732,8 +87250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -85743,9 +87261,9 @@ paths: application/json: schema: type: array - items: *611 + items: *624 examples: - default: *612 + default: *625 headers: Link: *40 '404': *6 @@ -85766,8 +87284,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -85803,9 +87321,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *624 examples: - default: &630 + default: &642 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -85837,8 +87355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *407 - - *408 + - *419 + - *420 - name: name in: path required: true @@ -85849,9 +87367,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *624 examples: - default: *630 + default: *642 '404': *6 x-github: githubCloudOnly: false @@ -85868,8 +87386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *407 - - *408 + - *419 + - *420 - name: name in: path required: true @@ -85908,7 +87426,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *624 examples: default: value: @@ -85934,8 +87452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *407 - - *408 + - *419 + - *420 - name: name in: path required: true @@ -85961,8 +87479,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -85998,8 +87516,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '202': *39 '403': @@ -86027,8 +87545,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -86054,9 +87572,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *407 - - *408 - - *503 + - *419 + - *420 + - *515 responses: '200': description: Response @@ -86118,8 +87636,8 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true required: - _links @@ -86201,8 +87719,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -86267,8 +87785,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -86302,9 +87820,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *528 + schema: *540 examples: - default: *631 + default: *643 '204': description: Response when already merged '404': @@ -86329,8 +87847,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *407 - - *408 + - *419 + - *420 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -86371,12 +87889,12 @@ paths: application/json: schema: type: array - items: &632 + items: &644 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *532 - required: *533 + properties: *544 + required: *545 examples: default: value: @@ -86432,8 +87950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -86473,9 +87991,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *644 examples: - default: &633 + default: &645 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -86534,9 +88052,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *407 - - *408 - - &634 + - *419 + - *420 + - &646 name: milestone_number description: The number that identifies the milestone. in: path @@ -86548,9 +88066,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *644 examples: - default: *633 + default: *645 '404': *6 x-github: githubCloudOnly: false @@ -86567,9 +88085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *407 - - *408 - - *634 + - *419 + - *420 + - *646 requestBody: required: false content: @@ -86607,9 +88125,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *644 examples: - default: *633 + default: *645 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86625,9 +88143,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *407 - - *408 - - *634 + - *419 + - *420 + - *646 responses: '204': description: Response @@ -86648,9 +88166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *407 - - *408 - - *634 + - *419 + - *420 + - *646 - *17 - *19 responses: @@ -86660,9 +88178,9 @@ paths: application/json: schema: type: array - items: *611 + items: *624 examples: - default: *612 + default: *625 headers: Link: *40 x-github: @@ -86681,12 +88199,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *407 - - *408 - - *635 - - *636 - - *170 - - *637 + - *419 + - *420 + - *647 + - *648 + - *174 + - *649 - *17 - *19 responses: @@ -86696,9 +88214,9 @@ paths: application/json: schema: type: array - items: *193 + items: *197 examples: - default: *638 + default: *650 headers: Link: *40 x-github: @@ -86722,8 +88240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -86781,14 +88299,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: &639 + schema: &651 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -86913,7 +88431,7 @@ paths: - custom_404 - public examples: - default: &640 + default: &652 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -86954,8 +88472,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -87009,11 +88527,11 @@ paths: description: Response content: application/json: - schema: *639 + schema: *651 examples: - default: *640 + default: *652 '422': *15 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87034,8 +88552,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -87121,7 +88639,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87142,14 +88660,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response '422': *15 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87169,8 +88687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -87180,7 +88698,7 @@ paths: application/json: schema: type: array - items: &641 + items: &653 title: Page Build description: Page Build type: object @@ -87274,8 +88792,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *407 - - *408 + - *419 + - *420 responses: '201': description: Response @@ -87320,16 +88838,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *641 + schema: *653 examples: - default: &642 + default: &654 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -87377,8 +88895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *407 - - *408 + - *419 + - *420 - name: build_id in: path required: true @@ -87389,9 +88907,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *653 examples: - default: *642 + default: *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87411,8 +88929,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -87517,9 +89035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *407 - - *408 - - &643 + - *419 + - *420 + - &655 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -87577,11 +89095,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *407 - - *408 - - *643 + - *419 + - *420 + - *655 responses: - '204': *123 + '204': *125 '404': *6 x-github: githubCloudOnly: false @@ -87606,8 +89124,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -87838,7 +89356,7 @@ paths: description: Empty response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -87865,8 +89383,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Private vulnerability reporting status @@ -87903,10 +89421,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: - '204': *123 + '204': *125 '422': *14 x-github: githubCloudOnly: false @@ -87925,10 +89443,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: - '204': *123 + '204': *125 '422': *14 x-github: githubCloudOnly: false @@ -87949,8 +89467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects parameters: - - *407 - - *408 + - *419 + - *420 - name: state description: Indicates the state of the projects to return. in: query @@ -87971,7 +89489,7 @@ paths: application/json: schema: type: array - items: *350 + items: *360 examples: default: value: @@ -88011,7 +89529,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *418 + '410': *430 '422': *7 x-github: githubCloudOnly: false @@ -88034,8 +89552,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -88061,13 +89579,13 @@ paths: description: Response content: application/json: - schema: *350 + schema: *360 examples: - default: *417 + default: *429 '401': *25 '403': *29 '404': *6 - '410': *418 + '410': *430 '422': *7 x-github: githubCloudOnly: false @@ -88090,8 +89608,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -88099,7 +89617,7 @@ paths: application/json: schema: type: array - items: *352 + items: *362 examples: default: value: @@ -88130,8 +89648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -88143,7 +89661,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *352 + items: *362 required: - properties examples: @@ -88193,8 +89711,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -88254,9 +89772,9 @@ paths: application/json: schema: type: array - items: *644 + items: *656 examples: - default: *645 + default: *657 headers: Link: *40 '304': *37 @@ -88288,8 +89806,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -88354,7 +89872,7 @@ paths: description: Response content: application/json: - schema: &649 + schema: &661 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -88465,8 +89983,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *532 - required: *533 + properties: *544 + required: *545 nullable: true active_lock_reason: type: string @@ -88511,7 +90029,7 @@ paths: nullable: true requested_teams: type: array - items: *374 + items: *386 nullable: true head: type: object @@ -88520,7 +90038,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *66 sha: type: string user: *4 @@ -88537,7 +90055,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *66 sha: type: string user: *4 @@ -88550,14 +90068,14 @@ paths: _links: type: object properties: - comments: *534 - commits: *534 - statuses: *534 - html: *534 - issue: *534 - review_comments: *534 - review_comment: *534 - self: *534 + comments: *546 + commits: *546 + statuses: *546 + html: *546 + issue: *546 + review_comments: *546 + review_comment: *546 + self: *546 required: - comments - commits @@ -88567,8 +90085,8 @@ paths: - review_comments - review_comment - self - author_association: *167 - auto_merge: *646 + author_association: *171 + auto_merge: *658 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -88660,7 +90178,7 @@ paths: - merged_by - review_comments examples: - default: &650 + default: &662 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -89187,8 +90705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: sort in: query required: false @@ -89207,7 +90725,7 @@ paths: enum: - asc - desc - - *170 + - *174 - *17 - *19 responses: @@ -89217,9 +90735,9 @@ paths: application/json: schema: type: array - items: *647 + items: *659 examples: - default: &652 + default: &664 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89296,17 +90814,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '200': description: Response content: application/json: - schema: *647 + schema: *659 examples: - default: &648 + default: &660 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89381,9 +90899,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -89405,9 +90923,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *659 examples: - default: *648 + default: *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89423,9 +90941,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '204': description: Response @@ -89446,9 +90964,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -89474,9 +90992,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 '404': *6 @@ -89497,9 +91015,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -89531,16 +91049,16 @@ paths: description: Reaction exists content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Reaction created content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '422': *15 x-github: githubCloudOnly: false @@ -89562,10 +91080,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *407 - - *408 - - *179 - - *399 + - *419 + - *420 + - *183 + - *411 responses: '204': description: Response @@ -89608,9 +91126,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *407 - - *408 - - &651 + - *419 + - *420 + - &663 name: pull_number description: The number that identifies the pull request. in: path @@ -89623,9 +91141,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *649 + schema: *661 examples: - default: *650 + default: *662 '304': *37 '404': *6 '406': @@ -89633,8 +91151,8 @@ paths: content: application/json: schema: *3 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89660,9 +91178,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: false content: @@ -89704,9 +91222,9 @@ paths: description: Response content: application/json: - schema: *649 + schema: *661 examples: - default: *650 + default: *662 '422': *15 '403': *29 x-github: @@ -89728,9 +91246,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: true content: @@ -89790,21 +91308,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '401': *25 '403': *29 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -89830,10 +91348,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *407 - - *408 - - *651 - - *190 + - *419 + - *420 + - *663 + - *194 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -89843,7 +91361,7 @@ paths: enum: - asc - desc - - *170 + - *174 - *17 - *19 responses: @@ -89853,9 +91371,9 @@ paths: application/json: schema: type: array - items: *647 + items: *659 examples: - default: *652 + default: *664 headers: Link: *40 x-github: @@ -89888,9 +91406,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: true content: @@ -89995,7 +91513,7 @@ paths: description: Response content: application/json: - schema: *647 + schema: *659 examples: example-for-a-multi-line-comment: value: @@ -90083,10 +91601,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *407 - - *408 - - *651 - - *179 + - *419 + - *420 + - *663 + - *183 requestBody: required: true content: @@ -90108,7 +91626,7 @@ paths: description: Response content: application/json: - schema: *647 + schema: *659 examples: default: value: @@ -90194,9 +91712,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 - *17 - *19 responses: @@ -90206,9 +91724,9 @@ paths: application/json: schema: type: array - items: *528 + items: *540 examples: - default: *653 + default: *665 headers: Link: *40 x-github: @@ -90238,9 +91756,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 - *17 - *19 responses: @@ -90250,7 +91768,7 @@ paths: application/json: schema: type: array - items: *543 + items: *555 examples: default: value: @@ -90268,8 +91786,8 @@ paths: headers: Link: *40 '422': *15 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90288,9 +91806,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 responses: '204': description: Response if pull request has been merged @@ -90313,9 +91831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: false content: @@ -90426,9 +91944,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 responses: '200': description: Response @@ -90444,7 +91962,7 @@ paths: items: *4 teams: type: array - items: *255 + items: *265 required: - users - teams @@ -90503,9 +92021,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: false content: @@ -90542,7 +92060,7 @@ paths: description: Response content: application/json: - schema: *644 + schema: *656 examples: default: value: @@ -91078,9 +92596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: true content: @@ -91114,7 +92632,7 @@ paths: description: Response content: application/json: - schema: *644 + schema: *656 examples: default: value: @@ -91619,9 +93137,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 - *17 - *19 responses: @@ -91631,7 +93149,7 @@ paths: application/json: schema: type: array - items: &654 + items: &666 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -91700,7 +93218,7 @@ paths: type: string body_text: type: string - author_association: *167 + author_association: *171 required: - id - node_id @@ -91782,9 +93300,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: false content: @@ -91870,9 +93388,9 @@ paths: description: Response content: application/json: - schema: *654 + schema: *666 examples: - default: &656 + default: &668 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91935,10 +93453,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 - - &655 + - *419 + - *420 + - *663 + - &667 name: review_id description: The unique identifier of the review. in: path @@ -91950,9 +93468,9 @@ paths: description: Response content: application/json: - schema: *654 + schema: *666 examples: - default: &657 + default: &669 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -92011,10 +93529,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 - - *655 + - *419 + - *420 + - *663 + - *667 requestBody: required: true content: @@ -92037,7 +93555,7 @@ paths: description: Response content: application/json: - schema: *654 + schema: *666 examples: default: value: @@ -92099,18 +93617,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 - - *655 + - *419 + - *420 + - *663 + - *667 responses: '200': description: Response content: application/json: - schema: *654 + schema: *666 examples: - default: *656 + default: *668 '422': *7 '404': *6 x-github: @@ -92137,10 +93655,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *407 - - *408 - - *651 - - *655 + - *419 + - *420 + - *663 + - *667 - *17 - *19 responses: @@ -92219,13 +93737,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *167 + author_association: *171 _links: type: object properties: - self: *534 - html: *534 - pull_request: *534 + self: *546 + html: *546 + pull_request: *546 required: - self - html @@ -92234,7 +93752,7 @@ paths: type: string body_html: type: string - reactions: *168 + reactions: *172 side: description: The side of the first line of the range for a multi-line comment. @@ -92375,10 +93893,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 - - *655 + - *419 + - *420 + - *663 + - *667 requestBody: required: true content: @@ -92406,7 +93924,7 @@ paths: description: Response content: application/json: - schema: *654 + schema: *666 examples: default: value: @@ -92469,10 +93987,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 - - *655 + - *419 + - *420 + - *663 + - *667 requestBody: required: true content: @@ -92507,9 +94025,9 @@ paths: description: Response content: application/json: - schema: *654 + schema: *666 examples: - default: *657 + default: *669 '404': *6 '422': *7 '403': *29 @@ -92531,9 +94049,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: false content: @@ -92596,8 +94114,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *407 - - *408 + - *419 + - *420 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -92610,9 +94128,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *670 examples: - default: &659 + default: &671 value: type: file encoding: base64 @@ -92654,8 +94172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *407 - - *408 + - *419 + - *420 - name: dir description: The alternate path to look for a README file in: path @@ -92675,9 +94193,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *670 examples: - default: *659 + default: *671 '404': *6 '422': *15 x-github: @@ -92699,8 +94217,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -92710,7 +94228,7 @@ paths: application/json: schema: type: array - items: &660 + items: &672 title: Release description: A release. type: object @@ -92777,7 +94295,7 @@ paths: author: *4 assets: type: array - items: &661 + items: &673 title: Release Asset description: Data related to a release. type: object @@ -92852,7 +94370,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *168 + reactions: *172 required: - assets_url - upload_url @@ -92964,8 +94482,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -93041,9 +94559,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *672 examples: - default: &664 + default: &676 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -93148,9 +94666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *407 - - *408 - - &662 + - *419 + - *420 + - &674 name: asset_id description: The unique identifier of the asset. in: path @@ -93162,9 +94680,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *673 examples: - default: &663 + default: &675 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -93199,7 +94717,7 @@ paths: type: User site_admin: false '404': *6 - '302': *545 + '302': *557 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93215,9 +94733,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *407 - - *408 - - *662 + - *419 + - *420 + - *674 requestBody: required: false content: @@ -93245,9 +94763,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *673 examples: - default: *663 + default: *675 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93263,9 +94781,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *407 - - *408 - - *662 + - *419 + - *420 + - *674 responses: '204': description: Response @@ -93289,8 +94807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -93375,16 +94893,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *660 + schema: *672 examples: - default: *664 + default: *676 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93401,8 +94919,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *407 - - *408 + - *419 + - *420 - name: tag description: tag parameter in: path @@ -93415,9 +94933,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *672 examples: - default: *664 + default: *676 '404': *6 x-github: githubCloudOnly: false @@ -93439,9 +94957,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *407 - - *408 - - &665 + - *419 + - *420 + - &677 name: release_id description: The unique identifier of the release. in: path @@ -93455,9 +94973,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *660 + schema: *672 examples: - default: *664 + default: *676 '401': description: Unauthorized x-github: @@ -93475,9 +94993,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 requestBody: required: false content: @@ -93541,9 +95059,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *672 examples: - default: *664 + default: *676 '404': description: Not Found if the discussion category name is invalid content: @@ -93564,9 +95082,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 responses: '204': description: Response @@ -93586,9 +95104,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 - *17 - *19 responses: @@ -93598,7 +95116,7 @@ paths: application/json: schema: type: array - items: *661 + items: *673 examples: default: value: @@ -93680,9 +95198,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 - name: name in: query required: true @@ -93708,7 +95226,7 @@ paths: description: Response for successful upload content: application/json: - schema: *661 + schema: *673 examples: response-for-successful-upload: value: @@ -93763,9 +95281,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -93789,9 +95307,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 '404': *6 @@ -93812,9 +95330,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 requestBody: required: true content: @@ -93844,16 +95362,16 @@ paths: description: Reaction exists content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Reaction created content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '422': *15 x-github: githubCloudOnly: false @@ -93875,10 +95393,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *407 - - *408 - - *665 - - *399 + - *419 + - *420 + - *677 + - *411 responses: '204': description: Response @@ -93902,9 +95420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 - *17 - *19 responses: @@ -93920,8 +95438,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *132 - - &666 + - *134 + - &678 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -93940,66 +95458,66 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *133 - - *666 - - allOf: - - *134 - - *666 - allOf: - *135 - - *666 - - allOf: - - *667 - - *666 + - *678 - allOf: - *136 - - *666 + - *678 - allOf: - *137 - - *666 + - *678 + - allOf: + - *679 + - *678 - allOf: - *138 - - *666 + - *678 - allOf: - *139 - - *666 + - *678 - allOf: - *140 - - *666 + - *678 - allOf: - *141 - - *666 + - *678 - allOf: - *142 - - *666 + - *678 - allOf: - *143 - - *666 + - *678 - allOf: - *144 - - *666 + - *678 - allOf: - *145 - - *666 + - *678 - allOf: - *146 - - *666 + - *678 - allOf: - *147 - - *666 + - *678 - allOf: - *148 - - *666 + - *678 - allOf: - *149 - - *666 + - *678 - allOf: - *150 - - *666 + - *678 - allOf: - *151 - - *666 + - *678 + - allOf: + - *152 + - *678 + - allOf: + - *153 + - *678 examples: default: value: @@ -94038,8 +95556,8 @@ paths: category: repos subcategory: rules parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 - name: includes_parents @@ -94050,7 +95568,7 @@ paths: schema: type: boolean default: true - - *668 + - *680 responses: '200': description: Response @@ -94058,7 +95576,7 @@ paths: application/json: schema: type: array - items: *152 + items: *154 examples: default: value: @@ -94089,7 +95607,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -94105,8 +95623,8 @@ paths: category: repos subcategory: rules parameters: - - *407 - - *408 + - *419 + - *420 requestBody: description: Request body required: true @@ -94126,16 +95644,16 @@ paths: - tag - push default: branch - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 - conditions: *126 + items: *133 + conditions: *128 rules: type: array description: An array of rules within the ruleset. - items: *669 + items: *681 required: - name - enforcement @@ -94166,9 +95684,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: &678 + default: &690 value: id: 42 name: super cool ruleset @@ -94201,7 +95719,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -94215,12 +95733,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *407 - - *408 - - *670 - - *249 - - *671 - - *672 + - *419 + - *420 + - *682 + - *259 + - *683 + - *684 - *17 - *19 responses: @@ -94228,11 +95746,11 @@ paths: description: Response content: application/json: - schema: *673 + schema: *685 examples: - default: *674 + default: *686 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94251,19 +95769,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *407 - - *408 - - *675 + - *419 + - *420 + - *687 responses: '200': description: Response content: application/json: - schema: *676 + schema: *688 examples: - default: *677 + default: *689 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94289,8 +95807,8 @@ paths: category: repos subcategory: rules parameters: - - *407 - - *408 + - *419 + - *420 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94310,11 +95828,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *678 + default: *690 '404': *6 - '500': *88 + '500': *90 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -94330,8 +95848,8 @@ paths: category: repos subcategory: rules parameters: - - *407 - - *408 + - *419 + - *420 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94356,16 +95874,16 @@ paths: - branch - tag - push - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 - conditions: *126 + items: *133 + conditions: *128 rules: description: An array of rules within the ruleset. type: array - items: *669 + items: *681 examples: default: value: @@ -94393,11 +95911,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *678 + default: *690 '404': *6 - '500': *88 + '500': *90 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -94413,8 +95931,8 @@ paths: category: repos subcategory: rules parameters: - - *407 - - *408 + - *419 + - *420 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94425,7 +95943,7 @@ paths: '204': description: Response '404': *6 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -94437,8 +95955,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 - name: ruleset_id @@ -94454,11 +95972,11 @@ paths: application/json: schema: type: array - items: *156 + items: *158 examples: - default: *361 + default: *371 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94475,8 +95993,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *407 - - *408 + - *419 + - *420 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94494,7 +96012,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *372 examples: default: value: @@ -94527,7 +96045,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94549,21 +96067,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *407 - - *408 - - *363 - - *364 - - *365 - - *366 - - *91 + - *419 + - *420 + - *373 + - *374 + - *375 + - *376 + - *93 - *19 - *17 - - *679 - - *680 - - *367 - - *368 - - *369 - - *370 + - *691 + - *692 + - *377 + - *378 + - *379 + - *380 responses: '200': description: Response @@ -94571,11 +96089,11 @@ paths: application/json: schema: type: array - items: &684 + items: &696 type: object properties: - number: *103 - created_at: *110 + number: *105 + created_at: *112 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -94583,15 +96101,15 @@ paths: format: date-time readOnly: true nullable: true - url: *108 - html_url: *109 + url: *110 + html_url: *111 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *681 - resolution: *682 + state: *693 + resolution: *694 resolved_at: type: string format: date-time @@ -94687,7 +96205,7 @@ paths: pull request. ' - oneOf: *683 + oneOf: *695 nullable: true has_more_locations: type: boolean @@ -94815,7 +96333,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94837,16 +96355,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *407 - - *408 - - *497 - - *370 + - *419 + - *420 + - *509 + - *380 responses: '200': description: Response content: application/json: - schema: *684 + schema: *696 examples: default: value: @@ -94877,7 +96395,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94898,9 +96416,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 requestBody: required: true content: @@ -94908,8 +96426,8 @@ paths: schema: type: object properties: - state: *681 - resolution: *682 + state: *693 + resolution: *694 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -94927,7 +96445,7 @@ paths: description: Response content: application/json: - schema: *684 + schema: *696 examples: default: value: @@ -94980,7 +96498,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -95002,9 +96520,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 - *19 - *17 responses: @@ -95015,7 +96533,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &861 + items: &875 type: object properties: type: @@ -95041,19 +96559,19 @@ paths: example: commit details: oneOf: - - *685 - - *686 - - *687 - - *688 - - *689 - - *690 - - *691 - - *692 - - *693 - - *694 - - *695 - - *696 - *697 + - *698 + - *699 + - *700 + - *701 + - *702 + - *703 + - *704 + - *705 + - *706 + - *707 + - *708 + - *709 examples: default: value: @@ -95117,7 +96635,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95139,8 +96657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -95148,14 +96666,14 @@ paths: schema: type: object properties: - reason: &699 + reason: &711 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *698 + placeholder_id: *710 required: - reason - placeholder_id @@ -95172,7 +96690,7 @@ paths: schema: type: object properties: - reason: *699 + reason: *711 expire_at: type: string format: date-time @@ -95195,7 +96713,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -95215,13 +96733,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *157 + '503': *159 '200': description: Response content: @@ -95231,7 +96749,7 @@ paths: properties: incremental_scans: type: array - items: &700 + items: &712 description: Information on a single scan performed by secret scanning on the repository type: object @@ -95257,15 +96775,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *700 + items: *712 backfill_scans: type: array - items: *700 + items: *712 custom_pattern_backfill_scans: type: array items: allOf: - - *700 + - *712 - type: object properties: pattern_name: @@ -95335,9 +96853,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *407 - - *408 - - *91 + - *419 + - *420 + - *93 - name: sort description: The property to sort the results by. in: query @@ -95349,8 +96867,8 @@ paths: - updated - published default: created - - *89 - - *90 + - *91 + - *92 - name: per_page description: The number of advisories to return per page. 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)." @@ -95380,9 +96898,9 @@ paths: application/json: schema: type: array - items: *701 + items: *713 examples: - default: *702 + default: *714 '400': *14 '404': *6 x-github: @@ -95405,8 +96923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -95479,7 +96997,7 @@ paths: login: type: string description: The username of the user credited. - type: *373 + type: *385 required: - login - type @@ -95566,9 +97084,9 @@ paths: description: Response content: application/json: - schema: *701 + schema: *713 examples: - default: &704 + default: &716 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -95801,8 +97319,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -95906,7 +97424,7 @@ paths: description: Response content: application/json: - schema: *701 + schema: *713 examples: default: value: @@ -96053,17 +97571,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *407 - - *408 - - *703 + - *419 + - *420 + - *715 responses: '200': description: Response content: application/json: - schema: *701 + schema: *713 examples: - default: *704 + default: *716 '403': *29 '404': *6 x-github: @@ -96087,9 +97605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *407 - - *408 - - *703 + - *419 + - *420 + - *715 requestBody: required: true content: @@ -96162,7 +97680,7 @@ paths: login: type: string description: The username of the user credited. - type: *373 + type: *385 required: - login - type @@ -96248,17 +97766,17 @@ paths: description: Response content: application/json: - schema: *701 + schema: *713 examples: - default: *704 - add_credit: *704 + default: *716 + add_credit: *716 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *207 + schema: *217 examples: invalid_state_transition: value: @@ -96289,9 +97807,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *407 - - *408 - - *703 + - *419 + - *420 + - *715 responses: '202': *39 '400': *14 @@ -96318,17 +97836,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *407 - - *408 - - *703 + - *419 + - *420 + - *715 responses: '202': description: Response content: application/json: - schema: *420 + schema: *432 examples: - default: *422 + default: *434 '400': *14 '422': *15 '403': *29 @@ -96354,8 +97872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -96454,8 +97972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -96464,7 +97982,7 @@ paths: application/json: schema: type: array - items: &705 + items: &717 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -96477,7 +97995,7 @@ paths: - 1124 - -435 '202': *39 - '204': *123 + '204': *125 '422': description: Repository contains more than 10,000 commits x-github: @@ -96497,8 +98015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -96547,7 +98065,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *123 + '204': *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96574,8 +98092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -96649,7 +98167,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *123 + '204': *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96671,8 +98189,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -96826,8 +98344,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -96837,7 +98355,7 @@ paths: application/json: schema: type: array - items: *705 + items: *717 examples: default: value: @@ -96850,7 +98368,7 @@ paths: - - 0 - 2 - 21 - '204': *123 + '204': *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96870,8 +98388,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *407 - - *408 + - *419 + - *420 - name: sha in: path required: true @@ -96925,7 +98443,7 @@ paths: description: Response content: application/json: - schema: *706 + schema: *718 examples: default: value: @@ -96979,8 +98497,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -96992,7 +98510,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -97012,14 +98530,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &707 + schema: &719 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -97087,8 +98605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -97114,7 +98632,7 @@ paths: description: Response content: application/json: - schema: *707 + schema: *719 examples: default: value: @@ -97141,8 +98659,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -97162,8 +98680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -97242,8 +98760,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -97251,7 +98769,7 @@ paths: application/json: schema: type: array - items: &708 + items: &720 title: Tag protection description: Tag protection type: object @@ -97303,8 +98821,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -97327,7 +98845,7 @@ paths: description: Response content: application/json: - schema: *708 + schema: *720 examples: default: value: @@ -97358,8 +98876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -97396,8 +98914,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *407 - - *408 + - *419 + - *420 - name: ref in: path required: true @@ -97433,8 +98951,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -97444,9 +98962,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 headers: Link: *40 '404': *6 @@ -97466,8 +98984,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *407 - - *408 + - *419 + - *420 - *19 - *17 responses: @@ -97475,7 +98993,7 @@ paths: description: Response content: application/json: - schema: &709 + schema: &721 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -97487,7 +99005,7 @@ paths: required: - names examples: - default: &710 + default: &722 value: names: - octocat @@ -97510,8 +99028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -97542,9 +99060,9 @@ paths: description: Response content: application/json: - schema: *709 + schema: *721 examples: - default: *710 + default: *722 '404': *6 '422': *7 x-github: @@ -97565,9 +99083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *407 - - *408 - - &711 + - *419 + - *420 + - &723 name: per description: The time frame to display results for. in: query @@ -97596,7 +99114,7 @@ paths: example: 128 clones: type: array - items: &712 + items: &724 title: Traffic type: object properties: @@ -97683,8 +99201,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -97774,8 +99292,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -97835,9 +99353,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *407 - - *408 - - *711 + - *419 + - *420 + - *723 responses: '200': description: Response @@ -97856,7 +99374,7 @@ paths: example: 3782 views: type: array - items: *712 + items: *724 required: - uniques - count @@ -97933,8 +99451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -97970,7 +99488,7 @@ paths: description: Response content: application/json: - schema: *224 + schema: *234 examples: default: value: @@ -98208,8 +99726,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -98232,8 +99750,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -98255,8 +99773,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -98282,8 +99800,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *407 - - *408 + - *419 + - *420 - name: ref in: path required: true @@ -98375,9 +99893,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *432 examples: - default: *422 + default: *434 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -98418,7 +99936,7 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: default: value: @@ -98528,7 +100046,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &720 + - &732 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -98537,7 +100055,7 @@ paths: schema: type: string example: members - - &725 + - &737 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -98548,7 +100066,7 @@ paths: default: 1 format: int32 example: 1 - - &726 + - &738 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -98590,7 +100108,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &714 + items: &727 allOf: - type: object required: @@ -98665,7 +100183,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &727 + meta: &739 type: object description: The metadata associated with the creation/updates to the user. @@ -98725,31 +100243,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &715 + '400': &728 description: Bad request content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 - '401': &716 - description: Authorization failure - '403': &717 + schema: *725 + '401': *726 + '403': &729 description: Permission denied - '429': &718 + '429': &730 description: Too many requests content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 - '500': &719 + schema: *725 + '500': &731 description: Internal server error content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 + schema: *725 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -98773,7 +100290,7 @@ paths: required: true content: application/json: - schema: &723 + schema: &735 type: object required: - schemas @@ -98829,9 +100346,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *714 + schema: *727 examples: - group: &721 + group: &733 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -98850,13 +100367,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *715 - '401': *716 - '403': *717 - '409': &724 + '400': *728 + '401': *726 + '403': *729 + '409': &736 description: Duplicate record detected - '429': *718 - '500': *719 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -98873,7 +100390,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &722 + - &734 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -98881,22 +100398,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *720 + - *732 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *714 + schema: *727 examples: - default: *721 - '400': *715 - '401': *716 - '403': *717 + default: *733 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '429': *718 - '500': *719 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -98915,13 +100432,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *722 + - *734 - *41 requestBody: required: true content: application/json: - schema: *723 + schema: *735 examples: group: summary: Group @@ -98947,17 +100464,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *714 + schema: *727 examples: - group: *721 - groupWithMembers: *721 - '400': *715 - '401': *716 - '403': *717 + group: *733 + groupWithMembers: *733 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '409': *724 - '429': *718 - '500': *719 + '409': *736 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -98981,13 +100498,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *722 + - *734 - *41 requestBody: required: true content: application/json: - schema: &734 + schema: &746 type: object required: - Operations @@ -99047,17 +100564,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *714 + schema: *727 examples: - updateGroup: *721 - addMembers: *721 - '400': *715 - '401': *716 - '403': *717 + updateGroup: *733 + addMembers: *733 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '409': *724 - '429': *718 - '500': *719 + '409': *736 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99073,17 +100590,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *722 + - *734 - *41 responses: '204': description: Group was deleted, no content - '400': *715 - '401': *716 - '403': *717 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '429': *718 - '500': *719 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99117,8 +100634,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *725 - - *726 + - *737 + - *738 - *41 responses: '200': @@ -99151,7 +100668,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &729 + items: &741 allOf: - type: object required: @@ -99230,7 +100747,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &728 + roles: &740 type: array description: The roles assigned to the user. items: @@ -99286,7 +100803,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *727 + meta: *739 startIndex: type: integer description: A starting index for the returned page @@ -99323,11 +100840,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *715 - '401': *716 - '403': *717 - '429': *718 - '500': *719 + '400': *728 + '401': *726 + '403': *729 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99351,7 +100868,7 @@ paths: required: true content: application/json: - schema: &732 + schema: &744 type: object required: - schemas @@ -99433,9 +100950,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *728 + roles: *740 examples: - user: &733 + user: &745 summary: User value: schemas: @@ -99482,9 +100999,9 @@ paths: description: User has been created content: application/scim+json: - schema: *729 + schema: *741 examples: - user: &730 + user: &742 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -99510,13 +101027,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *730 - '400': *715 - '401': *716 - '403': *717 - '409': *724 - '429': *718 - '500': *719 + enterpriseOwner: *742 + '400': *728 + '401': *726 + '403': *729 + '409': *736 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99533,7 +101050,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &731 + - &743 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -99546,15 +101063,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *729 + schema: *741 examples: - default: *730 - '400': *715 - '401': *716 - '403': *717 + default: *742 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '429': *718 - '500': *719 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99576,30 +101093,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *731 + - *743 - *41 requestBody: required: true content: application/json: - schema: *732 + schema: *744 examples: - user: *733 + user: *745 responses: '200': description: User was updated content: application/scim+json: - schema: *729 + schema: *741 examples: - user: *730 - '400': *715 - '401': *716 - '403': *717 + user: *742 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '409': *724 - '429': *718 - '500': *719 + '409': *736 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99634,13 +101151,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *731 + - *743 - *41 requestBody: required: true content: application/json: - schema: *734 + schema: *746 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -99680,18 +101197,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *729 + schema: *741 examples: - userMultiValuedProperties: *730 - userSingleValuedProperties: *730 - disableUser: *730 - '400': *715 - '401': *716 - '403': *717 + userMultiValuedProperties: *742 + userSingleValuedProperties: *742 + disableUser: *742 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '409': *724 - '429': *718 - '500': *719 + '409': *736 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99711,17 +101228,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *731 + - *743 - *41 responses: '204': description: User was deleted, no content - '400': *715 - '401': *716 - '403': *717 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '429': *718 - '500': *719 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99754,7 +101271,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *73 + - *75 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -99808,7 +101325,7 @@ paths: example: 1 Resources: type: array - items: &735 + items: &747 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -100039,22 +101556,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &736 + '404': &748 description: Resource not found content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 - '403': &737 + schema: *725 + '403': &749 description: Forbidden content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 - '400': *715 - '429': *718 + schema: *725 + '400': *728 + '429': *730 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -100074,15 +101591,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *73 + - *75 responses: '201': description: Response content: application/scim+json: - schema: *735 + schema: *747 examples: - default: &738 + default: &750 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -100105,17 +101622,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *736 - '403': *737 - '500': *719 + '404': *748 + '403': *749 + '500': *731 '409': description: Conflict content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 - '400': *715 + schema: *725 + '400': *728 requestBody: required: true content: @@ -100212,18 +101729,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - - *73 - - *731 + - *75 + - *743 responses: '200': description: Response content: application/scim+json: - schema: *735 + schema: *747 examples: - default: *738 - '404': *736 - '403': *737 + default: *750 + '404': *748 + '403': *749 '304': *37 x-github: githubCloudOnly: true @@ -100246,19 +101763,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *73 - - *731 + - *75 + - *743 responses: '200': description: Response content: application/scim+json: - schema: *735 + schema: *747 examples: - default: *738 + default: *750 '304': *37 - '404': *736 - '403': *737 + '404': *748 + '403': *749 requestBody: required: true content: @@ -100370,20 +101887,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - - *73 - - *731 + - *75 + - *743 responses: '200': description: Response content: application/scim+json: - schema: *735 + schema: *747 examples: - default: *738 + default: *750 '304': *37 - '404': *736 - '403': *737 - '400': *715 + '404': *748 + '403': *749 + '400': *728 '429': description: Response content: @@ -100473,13 +101990,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - - *73 - - *731 + - *75 + - *743 responses: '204': description: Response - '404': *736 - '403': *737 + '404': *748 + '403': *749 '304': *37 x-github: githubCloudOnly: true @@ -100594,7 +102111,7 @@ paths: html_url: type: string format: uri - repository: *224 + repository: *234 score: type: number file_size: @@ -100612,7 +102129,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &739 + text_matches: &751 title: Search Result Text Matches type: array items: @@ -100726,7 +102243,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *157 + '503': *159 '422': *15 '403': *29 x-github: @@ -100775,7 +102292,7 @@ paths: enum: - author-date - committer-date - - &740 + - &752 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -100846,7 +102363,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *464 + properties: *476 nullable: true comment_count: type: integer @@ -100866,7 +102383,7 @@ paths: url: type: string format: uri - verification: *589 + verification: *601 required: - author - committer @@ -100885,7 +102402,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *464 + properties: *476 nullable: true parents: type: array @@ -100898,12 +102415,12 @@ paths: type: string sha: type: string - repository: *224 + repository: *234 score: type: number node_id: type: string - text_matches: *739 + text_matches: *751 required: - sha - node_id @@ -101086,7 +102603,7 @@ paths: - interactions - created - updated - - *740 + - *752 - *17 - *19 - name: advanced_search @@ -101183,7 +102700,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: type: string state_reason: @@ -101200,8 +102718,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *532 - required: *533 + properties: *544 + required: *545 nullable: true comments: type: integer @@ -101215,7 +102733,7 @@ paths: type: string format: date-time nullable: true - text_matches: *739 + text_matches: *751 pull_request: type: object properties: @@ -101248,10 +102766,10 @@ paths: type: string score: type: number - author_association: *167 + author_association: *171 draft: type: boolean - repository: *64 + repository: *66 body_html: type: string body_text: @@ -101259,7 +102777,7 @@ paths: timeline_url: type: string format: uri - type: *316 + type: *326 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -101269,9 +102787,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 - reactions: *168 + properties: *169 + required: *170 + reactions: *172 required: - assignee - closed_at @@ -101387,7 +102905,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *157 + '503': *159 '422': *15 '304': *37 '403': *29 @@ -101443,7 +102961,7 @@ paths: enum: - created - updated - - *740 + - *752 - *17 - *19 responses: @@ -101487,7 +103005,7 @@ paths: nullable: true score: type: number - text_matches: *739 + text_matches: *751 required: - id - node_id @@ -101573,7 +103091,7 @@ paths: - forks - help-wanted-issues - updated - - *740 + - *752 - *17 - *19 responses: @@ -101792,8 +103310,8 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true permissions: type: object @@ -101812,7 +103330,7 @@ paths: - admin - pull - push - text_matches: *739 + text_matches: *751 temp_clone_token: type: string allow_merge_commit: @@ -102014,7 +103532,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *157 + '503': *159 '422': *15 '304': *37 x-github: @@ -102113,7 +103631,7 @@ paths: type: string format: uri nullable: true - text_matches: *739 + text_matches: *751 related: type: array nullable: true @@ -102306,7 +103824,7 @@ paths: - followers - repositories - joined - - *740 + - *752 - *17 - *19 responses: @@ -102410,7 +103928,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *739 + text_matches: *751 blog: type: string nullable: true @@ -102469,7 +103987,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *157 + '503': *159 '422': *15 x-github: githubCloudOnly: false @@ -102489,7 +104007,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &742 + - &755 name: team_id description: The unique identifier of the team. in: path @@ -102501,9 +104019,9 @@ paths: description: Response content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '404': *6 x-github: githubCloudOnly: false @@ -102530,7 +104048,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *742 + - *755 requestBody: required: true content: @@ -102593,16 +104111,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '201': description: Response content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '404': *6 '422': *15 '403': *29 @@ -102630,7 +104148,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *742 + - *755 responses: '204': description: Response @@ -102661,8 +104179,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *742 - - *91 + - *755 + - *93 - *17 - *19 responses: @@ -102672,9 +104190,9 @@ paths: application/json: schema: type: array - items: *390 + items: *402 examples: - default: *743 + default: *756 headers: Link: *40 x-github: @@ -102703,7 +104221,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *742 + - *755 requestBody: required: true content: @@ -102737,9 +104255,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: *391 + default: *403 x-github: triggersNotification: true githubCloudOnly: false @@ -102766,16 +104284,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *742 - - *392 + - *755 + - *404 responses: '200': description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: *391 + default: *403 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102800,8 +104318,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *742 - - *392 + - *755 + - *404 requestBody: required: false content: @@ -102824,9 +104342,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: *744 + default: *757 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102851,8 +104369,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *742 - - *392 + - *755 + - *404 responses: '204': description: Response @@ -102881,9 +104399,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *742 - - *392 - - *91 + - *755 + - *404 + - *93 - *17 - *19 responses: @@ -102893,9 +104411,9 @@ paths: application/json: schema: type: array - items: *393 + items: *405 examples: - default: *745 + default: *758 headers: Link: *40 x-github: @@ -102924,8 +104442,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *742 - - *392 + - *755 + - *404 requestBody: required: true content: @@ -102947,9 +104465,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: *394 + default: *406 x-github: triggersNotification: true githubCloudOnly: false @@ -102976,17 +104494,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *742 - - *392 - - *395 + - *755 + - *404 + - *407 responses: '200': description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: *394 + default: *406 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103011,9 +104529,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *742 - - *392 - - *395 + - *755 + - *404 + - *407 requestBody: required: true content: @@ -103035,9 +104553,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: *746 + default: *759 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103062,9 +104580,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *742 - - *392 - - *395 + - *755 + - *404 + - *407 responses: '204': description: Response @@ -103093,9 +104611,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *742 - - *392 - - *395 + - *755 + - *404 + - *407 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -103121,9 +104639,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 x-github: @@ -103152,9 +104670,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *742 - - *392 - - *395 + - *755 + - *404 + - *407 requestBody: required: true content: @@ -103186,9 +104704,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103214,8 +104732,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *742 - - *392 + - *755 + - *404 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -103241,9 +104759,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 x-github: @@ -103272,8 +104790,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *742 - - *392 + - *755 + - *404 requestBody: required: true content: @@ -103305,9 +104823,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103331,7 +104849,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *742 + - *755 - *17 - *19 responses: @@ -103341,9 +104859,9 @@ paths: application/json: schema: type: array - items: *313 + items: *323 examples: - default: *314 + default: *324 headers: Link: *40 x-github: @@ -103369,7 +104887,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *742 + - *755 - name: role description: Filters members returned by their role in the team. in: query @@ -103392,7 +104910,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '404': *6 @@ -103420,8 +104938,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *742 - - *246 + - *755 + - *256 responses: '204': description: if user is a member @@ -103457,8 +104975,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *742 - - *246 + - *755 + - *256 responses: '204': description: Response @@ -103497,8 +105015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *742 - - *246 + - *755 + - *256 responses: '204': description: Response @@ -103534,16 +105052,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *742 - - *246 + - *755 + - *256 responses: '200': description: Response content: application/json: - schema: *404 + schema: *416 examples: - response-if-user-is-a-team-maintainer: *747 + response-if-user-is-a-team-maintainer: *760 '404': *6 x-github: githubCloudOnly: false @@ -103576,8 +105094,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *742 - - *246 + - *755 + - *256 requestBody: required: false content: @@ -103602,9 +105120,9 @@ paths: description: Response content: application/json: - schema: *404 + schema: *416 examples: - response-if-users-membership-with-team-is-now-pending: *748 + response-if-users-membership-with-team-is-now-pending: *761 '403': description: Forbidden if team synchronization is set up '422': @@ -103638,8 +105156,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *742 - - *246 + - *755 + - *256 responses: '204': description: Response @@ -103667,7 +105185,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *742 + - *755 - *17 - *19 responses: @@ -103677,9 +105195,9 @@ paths: application/json: schema: type: array - items: *405 + items: *417 examples: - default: *749 + default: *762 headers: Link: *40 '404': *6 @@ -103705,16 +105223,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *742 - - *406 + - *755 + - *418 responses: '200': description: Response content: application/json: - schema: *405 + schema: *417 examples: - default: *750 + default: *763 '404': description: Not Found if project is not managed by this team x-github: @@ -103738,8 +105256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *742 - - *406 + - *755 + - *418 requestBody: required: false content: @@ -103806,8 +105324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *742 - - *406 + - *755 + - *418 responses: '204': description: Response @@ -103834,7 +105352,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *742 + - *755 - *17 - *19 responses: @@ -103844,9 +105362,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 '404': *6 @@ -103876,15 +105394,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *742 - - *407 - - *408 + - *755 + - *419 + - *420 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *751 + schema: *764 examples: alternative-response-with-extra-repository-information: value: @@ -104035,9 +105553,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *742 - - *407 - - *408 + - *755 + - *419 + - *420 requestBody: required: false content: @@ -104087,9 +105605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *742 - - *407 - - *408 + - *755 + - *419 + - *420 responses: '204': description: Response @@ -104118,15 +105636,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *742 + - *755 responses: '200': description: Response content: application/json: - schema: *409 + schema: *421 examples: - default: *410 + default: *422 '403': *29 '404': *6 x-github: @@ -104153,7 +105671,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *742 + - *755 requestBody: required: true content: @@ -104210,7 +105728,7 @@ paths: description: Response content: application/json: - schema: *409 + schema: *421 examples: default: value: @@ -104241,7 +105759,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *742 + - *755 - *17 - *19 responses: @@ -104251,9 +105769,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - response-if-child-teams-exist: *752 + response-if-child-teams-exist: *765 headers: Link: *40 '404': *6 @@ -104286,7 +105804,7 @@ paths: application/json: schema: oneOf: - - &754 + - &767 title: Private User description: Private User type: object @@ -104489,7 +106007,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *753 + - *766 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -104642,7 +106160,7 @@ paths: description: Response content: application/json: - schema: *754 + schema: *767 examples: default: value: @@ -104721,7 +106239,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 '304': *37 '404': *6 '403': *29 @@ -104744,7 +106262,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *246 + - *256 responses: '204': description: If the user is blocked @@ -104772,7 +106290,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *246 + - *256 responses: '204': description: Response @@ -104796,7 +106314,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *246 + - *256 responses: '204': description: Response @@ -104845,11 +106363,11 @@ paths: type: integer codespaces: type: array - items: *322 + items: *332 examples: - default: *323 + default: *333 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -104986,21 +106504,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '401': *25 '403': *29 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105040,7 +106558,7 @@ paths: type: integer secrets: type: array - items: &755 + items: &768 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -105080,7 +106598,7 @@ paths: - visibility - selected_repositories_url examples: - default: *520 + default: *532 headers: Link: *40 x-github: @@ -105150,13 +106668,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *234 + - *244 responses: '200': description: Response content: application/json: - schema: *755 + schema: *768 examples: default: value: @@ -105186,7 +106704,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *234 + - *244 requestBody: required: true content: @@ -105231,7 +106749,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -105259,7 +106777,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *234 + - *244 responses: '204': description: Response @@ -105284,7 +106802,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *234 + - *244 responses: '200': description: Response @@ -105300,13 +106818,13 @@ paths: type: integer repositories: type: array - items: *224 + items: *234 examples: - default: *756 + default: *769 '401': *25 '403': *29 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105327,7 +106845,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *234 + - *244 requestBody: required: true content: @@ -105359,7 +106877,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105381,7 +106899,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *234 + - *244 - name: repository_id in: path required: true @@ -105393,7 +106911,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105414,7 +106932,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *234 + - *244 - name: repository_id in: path required: true @@ -105426,7 +106944,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105446,17 +106964,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 responses: '200': description: Response content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -105480,7 +106998,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 requestBody: required: false content: @@ -105510,9 +107028,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '401': *25 '403': *29 '404': *6 @@ -105534,11 +107052,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 responses: '202': *39 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -105563,13 +107081,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 responses: '202': description: Response content: application/json: - schema: &757 + schema: &770 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -105610,7 +107128,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &758 + default: &771 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -105618,7 +107136,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -105642,7 +107160,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *324 + - *334 - name: export_id in: path required: true @@ -105655,9 +107173,9 @@ paths: description: Response content: application/json: - schema: *757 + schema: *770 examples: - default: *758 + default: *771 '404': *6 x-github: githubCloudOnly: false @@ -105678,7 +107196,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *324 + - *334 responses: '200': description: Response @@ -105694,11 +107212,11 @@ paths: type: integer machines: type: array - items: *759 + items: *772 examples: - default: *760 + default: *773 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -105725,7 +107243,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *324 + - *334 requestBody: required: true content: @@ -105775,13 +107293,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *420 + repository: *432 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *518 - required: *519 + properties: *530 + required: *531 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -106555,17 +108073,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 responses: '200': description: Response content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '304': *37 - '500': *88 + '500': *90 '400': *14 '401': *25 '402': @@ -106575,7 +108093,7 @@ paths: schema: *3 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106595,16 +108113,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 responses: '200': description: Response content: application/json: - schema: *322 + schema: *332 examples: - default: *517 - '500': *88 + default: *529 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -106633,9 +108151,9 @@ paths: application/json: schema: type: array - items: *334 + items: *344 examples: - default: &773 + default: &785 value: - id: 197 name: hello_docker @@ -106736,7 +108254,7 @@ paths: application/json: schema: type: array - items: &761 + items: &774 title: Email description: Email type: object @@ -106801,9 +108319,9 @@ paths: application/json: schema: type: array - items: *761 + items: *774 examples: - default: &775 + default: &787 value: - email: octocat@github.com verified: true @@ -106878,7 +108396,7 @@ paths: application/json: schema: type: array - items: *761 + items: *774 examples: default: value: @@ -106988,7 +108506,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '304': *37 @@ -107021,7 +108539,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '304': *37 @@ -107043,7 +108561,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *246 + - *256 responses: '204': description: if the person is followed by the authenticated user @@ -107073,7 +108591,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *246 + - *256 responses: '204': description: Response @@ -107098,7 +108616,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *246 + - *256 responses: '204': description: Response @@ -107134,7 +108652,7 @@ paths: application/json: schema: type: array - items: &762 + items: &775 title: GPG Key description: A unique encryption key type: object @@ -107265,7 +108783,7 @@ paths: - subkeys - revoked examples: - default: &789 + default: &801 value: - id: 3 name: Octocat's GPG Key @@ -107350,9 +108868,9 @@ paths: description: Response content: application/json: - schema: *762 + schema: *775 examples: - default: &763 + default: &776 value: id: 3 name: Octocat's GPG Key @@ -107409,7 +108927,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &764 + - &777 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -107421,9 +108939,9 @@ paths: description: Response content: application/json: - schema: *762 + schema: *775 examples: - default: *763 + default: *776 '404': *6 '304': *37 '403': *29 @@ -107446,7 +108964,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *764 + - *777 responses: '204': description: Response @@ -107635,9 +109153,9 @@ paths: type: string repositories: type: array - items: *64 + items: *66 examples: - default: *765 + default: *229 headers: Link: *40 '404': *6 @@ -107662,7 +109180,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *219 + - *206 responses: '204': description: Response @@ -107688,7 +109206,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *219 + - *206 responses: '204': description: Response @@ -107722,12 +109240,12 @@ paths: application/json: schema: anyOf: - - *311 + - *321 - type: object properties: {} additionalProperties: false examples: - default: *312 + default: *322 '204': description: Response when there are no restrictions x-github: @@ -107751,7 +109269,7 @@ paths: required: true content: application/json: - schema: *600 + schema: *612 examples: default: value: @@ -107762,7 +109280,7 @@ paths: description: Response content: application/json: - schema: *311 + schema: *321 examples: default: value: @@ -107843,7 +109361,7 @@ paths: - closed - all default: open - - *319 + - *329 - name: sort description: What to sort results by. in: query @@ -107855,8 +109373,8 @@ paths: - updated - comments default: created - - *91 - - *170 + - *93 + - *174 - *17 - *19 responses: @@ -107866,9 +109384,9 @@ paths: application/json: schema: type: array - items: *180 + items: *184 examples: - default: *320 + default: *330 headers: Link: *40 '404': *6 @@ -107901,7 +109419,7 @@ paths: application/json: schema: type: array - items: &766 + items: &778 title: Key description: Key type: object @@ -108002,9 +109520,9 @@ paths: description: Response content: application/json: - schema: *766 + schema: *778 examples: - default: &767 + default: &779 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -108037,15 +109555,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *629 + - *641 responses: '200': description: Response content: application/json: - schema: *766 + schema: *778 examples: - default: *767 + default: *779 '404': *6 '304': *37 '403': *29 @@ -108068,7 +109586,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *629 + - *641 responses: '204': description: Response @@ -108101,7 +109619,7 @@ paths: application/json: schema: type: array - items: &768 + items: &780 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -108158,7 +109676,7 @@ paths: - id - type - login - plan: *184 + plan: *188 required: - billing_cycle - next_billing_date @@ -108169,7 +109687,7 @@ paths: - account - plan examples: - default: &769 + default: &781 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -108231,9 +109749,9 @@ paths: application/json: schema: type: array - items: *768 + items: *780 examples: - default: *769 + default: *781 headers: Link: *40 '304': *37 @@ -108273,7 +109791,7 @@ paths: application/json: schema: type: array - items: *325 + items: *335 examples: default: value: @@ -108375,13 +109893,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *325 + schema: *335 examples: default: value: @@ -108439,7 +109957,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *73 + - *75 requestBody: required: true content: @@ -108464,7 +109982,7 @@ paths: description: Response content: application/json: - schema: *325 + schema: *335 examples: default: value: @@ -108532,7 +110050,7 @@ paths: application/json: schema: type: array - items: *327 + items: *337 examples: default: value: @@ -108785,7 +110303,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *337 examples: default: value: @@ -108965,7 +110483,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *328 + - *338 - name: exclude in: query required: false @@ -108978,7 +110496,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *337 examples: default: value: @@ -109172,7 +110690,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *328 + - *338 responses: '302': description: Response @@ -109198,7 +110716,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *328 + - *338 responses: '204': description: Response @@ -109227,8 +110745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *328 - - *770 + - *338 + - *782 responses: '204': description: Response @@ -109252,7 +110770,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *328 + - *338 - *17 - *19 responses: @@ -109262,9 +110780,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 '404': *6 @@ -109299,9 +110817,9 @@ paths: application/json: schema: type: array - items: *59 + items: *61 examples: - default: *771 + default: *783 headers: Link: *40 '304': *37 @@ -109343,7 +110861,7 @@ paths: - docker - nuget - container - - *772 + - *784 - *19 - *17 responses: @@ -109353,10 +110871,10 @@ paths: application/json: schema: type: array - items: *334 + items: *344 examples: - default: *773 - '400': *774 + default: *785 + '400': *786 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109376,16 +110894,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *336 - - *337 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *334 + schema: *344 examples: - default: &790 + default: &802 value: id: 40201 name: octo-name @@ -109498,8 +111016,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *336 - - *337 + - *346 + - *347 responses: '204': description: Response @@ -109529,8 +111047,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *336 - - *337 + - *346 + - *347 - name: token description: package token schema: @@ -109562,8 +111080,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *336 - - *337 + - *346 + - *347 - *19 - *17 - name: state @@ -109583,7 +111101,7 @@ paths: application/json: schema: type: array - items: *338 + items: *348 examples: default: value: @@ -109632,15 +111150,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *336 - - *337 - - *339 + - *346 + - *347 + - *349 responses: '200': description: Response content: application/json: - schema: *338 + schema: *348 examples: default: value: @@ -109676,9 +111194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *336 - - *337 - - *339 + - *346 + - *347 + - *349 responses: '204': description: Response @@ -109708,9 +111226,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *336 - - *337 - - *339 + - *346 + - *347 + - *349 responses: '204': description: Response @@ -109766,7 +111284,7 @@ paths: description: Response content: application/json: - schema: *350 + schema: *360 examples: default: value: @@ -109838,9 +111356,9 @@ paths: application/json: schema: type: array - items: *761 + items: *774 examples: - default: *775 + default: *787 headers: Link: *40 '304': *37 @@ -109951,9 +111469,9 @@ paths: application/json: schema: type: array - items: *64 + items: *66 examples: - default: &782 + default: &794 summary: Default response value: - id: 1296269 @@ -110257,9 +111775,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *432 examples: - default: *422 + default: *434 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -110297,9 +111815,9 @@ paths: application/json: schema: type: array - items: *602 + items: *614 examples: - default: *776 + default: *788 headers: Link: *40 '304': *37 @@ -110322,12 +111840,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *315 + - *325 responses: '204': description: Response '403': *29 - '409': *99 + '409': *101 '404': *6 '304': *37 x-github: @@ -110345,11 +111863,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *315 + - *325 responses: '204': description: Response - '409': *99 + '409': *101 '304': *37 '404': *6 '403': *29 @@ -110378,7 +111896,7 @@ paths: application/json: schema: type: array - items: &777 + items: &789 title: Social account description: Social media account type: object @@ -110393,7 +111911,7 @@ paths: - provider - url examples: - default: &778 + default: &790 value: - provider: twitter url: https://twitter.com/github @@ -110455,9 +111973,9 @@ paths: application/json: schema: type: array - items: *777 + items: *789 examples: - default: *778 + default: *790 '422': *15 '304': *37 '404': *6 @@ -110544,7 +112062,7 @@ paths: application/json: schema: type: array - items: &779 + items: &791 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -110564,7 +112082,7 @@ paths: - title - created_at examples: - default: &791 + default: &803 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -110630,9 +112148,9 @@ paths: description: Response content: application/json: - schema: *779 + schema: *791 examples: - default: &780 + default: &792 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -110663,7 +112181,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &781 + - &793 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -110675,9 +112193,9 @@ paths: description: Response content: application/json: - schema: *779 + schema: *791 examples: - default: *780 + default: *792 '404': *6 '304': *37 '403': *29 @@ -110700,7 +112218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *781 + - *793 responses: '204': description: Response @@ -110729,7 +112247,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &792 + - &804 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -110742,7 +112260,7 @@ paths: - created - updated default: created - - *91 + - *93 - *17 - *19 responses: @@ -110752,13 +112270,13 @@ paths: application/json: schema: type: array - items: *64 + items: *66 examples: - default-response: *782 + default-response: *794 application/vnd.github.v3.star+json: schema: type: array - items: &793 + items: &805 title: Starred Repository description: Starred Repository type: object @@ -110766,7 +112284,7 @@ paths: starred_at: type: string format: date-time - repo: *64 + repo: *66 required: - starred_at - repo @@ -110914,8 +112432,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response if this repository is starred by you @@ -110943,8 +112461,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -110968,8 +112486,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -111002,9 +112520,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 '304': *37 @@ -111041,7 +112559,7 @@ paths: application/json: schema: type: array - items: *388 + items: *400 examples: default: value: @@ -111119,7 +112637,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *186 + - *190 responses: '200': description: Response @@ -111127,10 +112645,10 @@ paths: application/json: schema: oneOf: - - *754 - - *753 + - *767 + - *766 examples: - default-response: &784 + default-response: &796 summary: Default response value: login: octocat @@ -111165,7 +112683,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &785 + response-with-git-hub-plan-information: &797 summary: Response with GitHub plan information value: login: octocat @@ -111225,7 +112743,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *783 + - *795 - *17 responses: '200': @@ -111236,7 +112754,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: example: ; rel="next" @@ -111266,7 +112784,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *246 + - *256 responses: '200': description: Response @@ -111274,11 +112792,11 @@ paths: application/json: schema: oneOf: - - *754 - - *753 + - *767 + - *766 examples: - default-response: *784 - response-with-git-hub-plan-information: *785 + default-response: *796 + response-with-git-hub-plan-information: *797 '404': *6 x-github: githubCloudOnly: false @@ -111302,9 +112820,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *89 - - *90 - - *246 + - *91 + - *92 + - *256 requestBody: required: true content: @@ -111327,8 +112845,8 @@ paths: required: - subject_digests examples: - default: *786 - withPredicateType: *787 + default: *798 + withPredicateType: *799 responses: '200': description: Response @@ -111381,7 +112899,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *788 + default: *800 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111399,7 +112917,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk parameters: - - *246 + - *256 requestBody: required: true content: @@ -111464,7 +112982,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *246 + - *256 - name: subject_digest description: Subject Digest in: path @@ -111495,7 +113013,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id parameters: - - *246 + - *256 - name: attestation_id description: Attestation ID in: path @@ -111531,9 +113049,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations parameters: - *17 - - *89 - - *90 - - *246 + - *91 + - *92 + - *256 - name: subject_digest description: Subject Digest in: path @@ -111583,12 +113101,12 @@ paths: bundle_url: type: string examples: - default: *460 + default: *472 '201': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -111614,7 +113132,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *246 + - *256 responses: '200': description: Response @@ -111622,9 +113140,9 @@ paths: application/json: schema: type: array - items: *334 + items: *344 examples: - default: *773 + default: *785 '403': *29 '401': *25 x-github: @@ -111647,7 +113165,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -111657,7 +113175,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -111728,8 +113246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *246 - - *73 + - *256 + - *75 - *17 - *19 responses: @@ -111739,7 +113257,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -111818,7 +113336,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -111828,7 +113346,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -111895,7 +113413,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -111907,7 +113425,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -111926,7 +113444,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *246 + - *256 - *17 - *19 responses: @@ -111938,7 +113456,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -111957,7 +113475,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - - *246 + - *256 - name: target_user in: path required: true @@ -111984,8 +113502,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *246 - - *170 + - *256 + - *174 - *17 - *19 responses: @@ -111995,9 +113513,9 @@ paths: application/json: schema: type: array - items: *171 + items: *175 examples: - default: *172 + default: *176 headers: Link: *40 '422': *15 @@ -112018,7 +113536,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -112028,9 +113546,9 @@ paths: application/json: schema: type: array - items: *762 + items: *775 examples: - default: *789 + default: *801 headers: Link: *40 x-github: @@ -112054,7 +113572,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *246 + - *256 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -112126,7 +113644,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *246 + - *256 responses: '200': description: Response @@ -112134,7 +113652,7 @@ paths: application/json: schema: *22 examples: - default: *599 + default: *611 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112152,7 +113670,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -112207,7 +113725,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -112217,9 +113735,9 @@ paths: application/json: schema: type: array - items: *59 + items: *61 examples: - default: *771 + default: *783 headers: Link: *40 x-github: @@ -112258,8 +113776,8 @@ paths: - docker - nuget - container - - *772 - - *246 + - *784 + - *256 - *19 - *17 responses: @@ -112269,12 +113787,12 @@ paths: application/json: schema: type: array - items: *334 + items: *344 examples: - default: *773 + default: *785 '403': *29 '401': *25 - '400': *774 + '400': *786 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112294,17 +113812,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *336 - - *337 - - *246 + - *346 + - *347 + - *256 responses: '200': description: Response content: application/json: - schema: *334 + schema: *344 examples: - default: *790 + default: *802 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112325,9 +113843,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *336 - - *337 - - *246 + - *346 + - *347 + - *256 responses: '204': description: Response @@ -112359,9 +113877,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *336 - - *337 - - *246 + - *346 + - *347 + - *256 - name: token description: package token schema: @@ -112393,9 +113911,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *336 - - *337 - - *246 + - *346 + - *347 + - *256 responses: '200': description: Response @@ -112403,7 +113921,7 @@ paths: application/json: schema: type: array - items: *338 + items: *348 examples: default: value: @@ -112461,16 +113979,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - - *336 - - *337 - - *339 - - *246 + - *346 + - *347 + - *349 + - *256 responses: '200': description: Response content: application/json: - schema: *338 + schema: *348 examples: default: value: @@ -112505,10 +114023,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *336 - - *337 - - *246 - - *339 + - *346 + - *347 + - *256 + - *349 responses: '204': description: Response @@ -112540,10 +114058,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *336 - - *337 - - *246 - - *339 + - *346 + - *347 + - *256 + - *349 responses: '204': description: Response @@ -112569,7 +114087,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects parameters: - - *246 + - *256 - name: state description: Indicates the state of the projects to return. in: query @@ -112590,7 +114108,7 @@ paths: application/json: schema: type: array - items: *350 + items: *360 examples: default: value: @@ -112652,7 +114170,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -112662,7 +114180,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -112741,7 +114259,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -112751,7 +114269,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -112828,7 +114346,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *246 + - *256 - name: type description: Limit results to repositories of the specified type. in: query @@ -112871,9 +114389,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -112897,15 +114415,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *246 + - *256 responses: '200': description: Response content: application/json: - schema: *375 + schema: *387 examples: - default: *376 + default: *388 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112927,15 +114445,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *246 + - *256 responses: '200': description: Response content: application/json: - schema: *380 + schema: *392 examples: - default: *381 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112957,15 +114475,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *246 + - *256 responses: '200': description: Response content: application/json: - schema: *382 + schema: *394 examples: - default: *383 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112985,11 +114503,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *246 - - *199 - - *200 - - *201 - - *202 + - *256 + - *209 + - *210 + - *211 + - *212 responses: '200': description: Response when getting a billing usage report @@ -113059,8 +114577,8 @@ paths: repositoryName: user/example '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113078,7 +114596,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -113088,9 +114606,9 @@ paths: application/json: schema: type: array - items: *777 + items: *789 examples: - default: *778 + default: *790 headers: Link: *40 x-github: @@ -113110,7 +114628,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -113120,9 +114638,9 @@ paths: application/json: schema: type: array - items: *779 + items: *791 examples: - default: *791 + default: *803 headers: Link: *40 x-github: @@ -113146,9 +114664,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *246 - - *792 - - *91 + - *256 + - *804 + - *93 - *17 - *19 responses: @@ -113159,11 +114677,11 @@ paths: schema: anyOf: - type: array - items: *793 + items: *805 - type: array - items: *64 + items: *66 examples: - default-response: *782 + default-response: *794 headers: Link: *40 x-github: @@ -113182,7 +114700,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -113192,9 +114710,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -113322,7 +114840,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &794 + enterprise: &806 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -113380,7 +114898,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &795 + installation: &807 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -113399,7 +114917,7 @@ x-webhooks: required: - id - node_id - organization: &796 + organization: &808 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -113459,13 +114977,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &797 + repository: &809 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &834 + properties: &846 id: description: Unique identifier of the repository example: 42 @@ -113485,8 +115003,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true organization: title: Simple User @@ -114148,7 +115666,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &835 + required: &847 - archive_url - assignees_url - blobs_url @@ -114299,10 +115817,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -114378,11 +115896,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - rule: &798 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + rule: &810 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -114605,11 +116123,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - rule: *798 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + rule: *810 sender: *4 required: - action @@ -114792,11 +116310,11 @@ x-webhooks: - everyone required: - from - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - rule: *798 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + rule: *810 sender: *4 required: - action @@ -114867,7 +116385,7 @@ x-webhooks: required: true content: application/json: - schema: &801 + schema: &813 title: Exemption request cancellation event type: object properties: @@ -114875,11 +116393,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - exemption_request: &799 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + exemption_request: &811 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -115112,7 +116630,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &800 + items: &812 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -115220,7 +116738,7 @@ x-webhooks: required: true content: application/json: - schema: &802 + schema: &814 title: Exemption request completed event type: object properties: @@ -115228,11 +116746,11 @@ x-webhooks: type: string enum: - completed - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - exemption_request: *799 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + exemption_request: *811 sender: *4 required: - action @@ -115302,7 +116820,7 @@ x-webhooks: required: true content: application/json: - schema: &803 + schema: &815 title: Exemption request created event type: object properties: @@ -115310,11 +116828,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - exemption_request: *799 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + exemption_request: *811 sender: *4 required: - action @@ -115384,7 +116902,7 @@ x-webhooks: required: true content: application/json: - schema: &804 + schema: &816 title: Exemption response dismissed event type: object properties: @@ -115392,12 +116910,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - exemption_request: *799 - exemption_response: *800 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + exemption_request: *811 + exemption_response: *812 sender: *4 required: - action @@ -115469,7 +116987,7 @@ x-webhooks: required: true content: application/json: - schema: &805 + schema: &817 title: Exemption response submitted event type: object properties: @@ -115477,12 +116995,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - exemption_request: *799 - exemption_response: *800 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + exemption_request: *811 + exemption_response: *812 sender: *4 required: - action @@ -115555,7 +117073,7 @@ x-webhooks: required: true content: application/json: - schema: *801 + schema: *813 responses: '200': description: Return a 200 status to indicate that the data was received @@ -115622,7 +117140,7 @@ x-webhooks: required: true content: application/json: - schema: *802 + schema: *814 responses: '200': description: Return a 200 status to indicate that the data was received @@ -115689,7 +117207,7 @@ x-webhooks: required: true content: application/json: - schema: *803 + schema: *815 responses: '200': description: Return a 200 status to indicate that the data was received @@ -115756,7 +117274,7 @@ x-webhooks: required: true content: application/json: - schema: *804 + schema: *816 responses: '200': description: Return a 200 status to indicate that the data was received @@ -115824,7 +117342,7 @@ x-webhooks: required: true content: application/json: - schema: *805 + schema: *817 responses: '200': description: Return a 200 status to indicate that the data was received @@ -115902,7 +117420,7 @@ x-webhooks: type: string enum: - completed - check_run: &807 + check_run: &819 title: CheckRun description: A check performed on the code of a given code change type: object @@ -115955,8 +117473,8 @@ x-webhooks: type: string pull_requests: type: array - items: *479 - repository: *224 + items: *491 + repository: *234 status: example: completed type: string @@ -115993,7 +117511,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *806 + deployment: *818 details_url: example: https://example.com type: string @@ -116043,7 +117561,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *479 + items: *491 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -116078,9 +117596,9 @@ x-webhooks: - output - app - pull_requests - installation: *795 - organization: *796 - repository: *797 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - check_run @@ -116473,10 +117991,10 @@ x-webhooks: type: string enum: - created - check_run: *807 - installation: *795 - organization: *796 - repository: *797 + check_run: *819 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - check_run @@ -116872,10 +118390,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *807 - installation: *795 - organization: *796 - repository: *797 + check_run: *819 + installation: *807 + organization: *808 + repository: *809 requested_action: description: The action requested by the user. type: object @@ -117280,10 +118798,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *807 - installation: *795 - organization: *796 - repository: *797 + check_run: *819 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - check_run @@ -118260,10 +119778,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -118933,10 +120451,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -119600,10 +121118,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -119766,7 +121284,7 @@ x-webhooks: required: - login - id - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -119911,20 +121429,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &808 + commit_oid: &820 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *794 - installation: *795 - organization: *796 - ref: &809 + enterprise: *806 + installation: *807 + organization: *808 + ref: &821 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *797 + repository: *809 sender: *4 required: - action @@ -120086,7 +121604,7 @@ x-webhooks: required: - login - id - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -120316,12 +121834,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *808 - enterprise: *794 - installation: *795 - organization: *796 - ref: *809 - repository: *797 + commit_oid: *820 + enterprise: *806 + installation: *807 + organization: *808 + ref: *821 + repository: *809 sender: *4 required: - action @@ -120416,7 +121934,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -120584,12 +122102,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *808 - enterprise: *794 - installation: *795 - organization: *796 - ref: *809 - repository: *797 + commit_oid: *820 + enterprise: *806 + installation: *807 + organization: *808 + ref: *821 + repository: *809 sender: *4 required: - action @@ -120752,7 +122270,7 @@ x-webhooks: required: - login - id - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -120918,12 +122436,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *808 - enterprise: *794 - installation: *795 - organization: *796 - ref: *809 - repository: *797 + commit_oid: *820 + enterprise: *806 + installation: *807 + organization: *808 + ref: *821 + repository: *809 sender: *4 required: - action @@ -121020,7 +122538,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -121188,16 +122706,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *797 + repository: *809 sender: *4 required: - action @@ -121291,7 +122809,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -121431,12 +122949,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *808 - enterprise: *794 - installation: *795 - organization: *796 - ref: *809 - repository: *797 + commit_oid: *820 + enterprise: *806 + installation: *807 + organization: *808 + ref: *821 + repository: *809 sender: *4 required: - action @@ -121693,10 +123211,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -121776,18 +123294,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *796 - pusher_type: &810 + organization: *808 + pusher_type: &822 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &811 + ref: &823 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -121797,7 +123315,7 @@ x-webhooks: enum: - tag - branch - repository: *797 + repository: *809 sender: *4 required: - ref @@ -121879,10 +123397,10 @@ x-webhooks: type: string enum: - created - definition: *119 - enterprise: *794 - installation: *795 - organization: *796 + definition: *121 + enterprise: *806 + installation: *807 + organization: *808 sender: *4 required: - action @@ -121967,9 +123485,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 sender: *4 required: - action @@ -122046,10 +123564,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *119 - enterprise: *794 - installation: *795 - organization: *796 + definition: *121 + enterprise: *806 + installation: *807 + organization: *808 sender: *4 required: - action @@ -122126,10 +123644,10 @@ x-webhooks: type: string enum: - updated - definition: *119 - enterprise: *794 - installation: *795 - organization: *796 + definition: *121 + enterprise: *806 + installation: *807 + organization: *808 sender: *4 required: - action @@ -122206,19 +123724,19 @@ x-webhooks: type: string enum: - updated - enterprise: *794 - installation: *795 - repository: *797 - organization: *796 + enterprise: *806 + installation: *807 + repository: *809 + organization: *808 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *352 + items: *362 old_property_values: type: array description: The old custom property values for the repository. - items: *352 + items: *362 required: - action - repository @@ -122294,18 +123812,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *794 - installation: *795 - organization: *796 - pusher_type: *810 - ref: *811 + enterprise: *806 + installation: *807 + organization: *808 + pusher_type: *822 + ref: *823 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *797 + repository: *809 sender: *4 required: - ref @@ -122389,11 +123907,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122477,11 +123995,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122565,11 +124083,11 @@ x-webhooks: type: string enum: - created - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122651,11 +124169,11 @@ x-webhooks: type: string enum: - dismissed - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122737,11 +124255,11 @@ x-webhooks: type: string enum: - fixed - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122824,11 +124342,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122910,11 +124428,11 @@ x-webhooks: type: string enum: - reopened - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122991,9 +124509,9 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - key: &812 + enterprise: *806 + installation: *807 + key: &824 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -123029,8 +124547,8 @@ x-webhooks: - verified - created_at - read_only - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -123107,11 +124625,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - key: *812 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + key: *824 + organization: *808 + repository: *809 sender: *4 required: - action @@ -123672,12 +125190,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - workflow: &816 + workflow: &828 title: Workflow type: object nullable: true @@ -124403,13 +125921,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *555 + deployment: *567 pull_requests: type: array - items: *649 - repository: *797 - organization: *796 - installation: *795 + items: *661 + repository: *809 + organization: *808 + installation: *807 sender: *4 responses: '200': @@ -124480,7 +125998,7 @@ x-webhooks: type: string enum: - approved - approver: &813 + approver: &825 type: object properties: avatar_url: @@ -124523,11 +126041,11 @@ x-webhooks: type: string comment: type: string - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - reviewers: &814 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + reviewers: &826 type: array items: type: object @@ -124606,7 +126124,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &815 + workflow_job_run: &827 type: object properties: conclusion: @@ -125337,18 +126855,18 @@ x-webhooks: type: string enum: - rejected - approver: *813 + approver: *825 comment: type: string - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - reviewers: *814 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + reviewers: *826 sender: *4 since: type: string - workflow_job_run: *815 + workflow_job_run: *827 workflow_job_runs: type: array items: @@ -126052,13 +127570,13 @@ x-webhooks: type: string enum: - requested - enterprise: *794 + enterprise: *806 environment: type: string - installation: *795 - organization: *796 - repository: *797 - requestor: &821 + installation: *807 + organization: *808 + repository: *809 + requestor: &833 title: User type: object nullable: true @@ -127957,12 +129475,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - workflow: *816 + workflow: *828 workflow_run: title: Deployment Workflow Run type: object @@ -128642,7 +130160,7 @@ x-webhooks: type: string enum: - answered - answer: &819 + answer: &831 type: object properties: author_association: @@ -128799,7 +130317,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &817 + discussion: &829 title: Discussion description: A Discussion in a repository. type: object @@ -129085,7 +130603,7 @@ x-webhooks: - id labels: type: array - items: *611 + items: *624 required: - repository_url - category @@ -129107,10 +130625,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129237,11 +130755,11 @@ x-webhooks: - from required: - category - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129324,11 +130842,11 @@ x-webhooks: type: string enum: - closed - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129410,7 +130928,7 @@ x-webhooks: type: string enum: - created - comment: &818 + comment: &830 type: object properties: author_association: @@ -129567,11 +131085,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129654,12 +131172,12 @@ x-webhooks: type: string enum: - deleted - comment: *818 - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + comment: *830 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129754,12 +131272,12 @@ x-webhooks: - from required: - body - comment: *818 - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + comment: *830 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129843,11 +131361,11 @@ x-webhooks: type: string enum: - created - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129929,11 +131447,11 @@ x-webhooks: type: string enum: - deleted - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130033,11 +131551,11 @@ x-webhooks: type: string required: - from - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130119,10 +131637,10 @@ x-webhooks: type: string enum: - labeled - discussion: *817 - enterprise: *794 - installation: *795 - label: &820 + discussion: *829 + enterprise: *806 + installation: *807 + label: &832 title: Label type: object properties: @@ -130154,8 +131672,8 @@ x-webhooks: - color - default - description - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130238,11 +131756,11 @@ x-webhooks: type: string enum: - locked - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130324,11 +131842,11 @@ x-webhooks: type: string enum: - pinned - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130410,11 +131928,11 @@ x-webhooks: type: string enum: - reopened - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130499,16 +132017,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *817 - new_repository: *797 + new_discussion: *829 + new_repository: *809 required: - new_discussion - new_repository - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130591,10 +132109,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *817 - old_answer: *819 - organization: *796 - repository: *797 + discussion: *829 + old_answer: *831 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130676,12 +132194,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *817 - enterprise: *794 - installation: *795 - label: *820 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130764,11 +132282,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130850,11 +132368,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130923,7 +132441,7 @@ x-webhooks: required: true content: application/json: - schema: *803 + schema: *815 responses: '200': description: Return a 200 status to indicate that the data was received @@ -130986,7 +132504,7 @@ x-webhooks: required: true content: application/json: - schema: *805 + schema: *817 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131052,7 +132570,7 @@ x-webhooks: required: true content: application/json: - schema: *801 + schema: *813 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131118,7 +132636,7 @@ x-webhooks: required: true content: application/json: - schema: *802 + schema: *814 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131184,7 +132702,7 @@ x-webhooks: required: true content: application/json: - schema: *803 + schema: *815 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131250,7 +132768,7 @@ x-webhooks: required: true content: application/json: - schema: *804 + schema: *816 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131316,7 +132834,7 @@ x-webhooks: required: true content: application/json: - schema: *805 + schema: *817 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131383,7 +132901,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *794 + enterprise: *806 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -132043,9 +133561,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *795 - organization: *796 - repository: *797 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - forkee @@ -132191,9 +133709,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pages: description: The pages that were updated. type: array @@ -132230,7 +133748,7 @@ x-webhooks: - action - sha - html_url - repository: *797 + repository: *809 sender: *4 required: - pages @@ -132306,10 +133824,10 @@ x-webhooks: type: string enum: - created - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories: &822 + organization: *808 + repositories: &834 description: An array of repository objects that the installation can access. type: array @@ -132335,8 +133853,8 @@ x-webhooks: - name - full_name - private - repository: *797 - requester: *821 + repository: *809 + requester: *833 sender: *4 required: - action @@ -132411,11 +133929,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories: *822 - repository: *797 + organization: *808 + repositories: *834 + repository: *809 requester: nullable: true sender: *4 @@ -132491,11 +134009,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories: *822 - repository: *797 + organization: *808 + repositories: *834 + repository: *809 requester: nullable: true sender: *4 @@ -132571,10 +134089,10 @@ x-webhooks: type: string enum: - added - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories_added: &823 + organization: *808 + repositories_added: &835 description: An array of repository objects, which were added to the installation. type: array @@ -132620,15 +134138,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *797 - repository_selection: &824 + repository: *809 + repository_selection: &836 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *821 + requester: *833 sender: *4 required: - action @@ -132707,10 +134225,10 @@ x-webhooks: type: string enum: - removed - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories_added: *823 + organization: *808 + repositories_added: *835 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -132737,9 +134255,9 @@ x-webhooks: - name - full_name - private - repository: *797 - repository_selection: *824 - requester: *821 + repository: *809 + repository_selection: *836 + requester: *833 sender: *4 required: - action @@ -132818,11 +134336,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories: *822 - repository: *797 + organization: *808 + repositories: *834 + repository: *809 requester: nullable: true sender: *4 @@ -133001,10 +134519,10 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 target_type: type: string @@ -133083,11 +134601,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories: *822 - repository: *797 + organization: *808 + repositories: *834 + repository: *809 requester: nullable: true sender: *4 @@ -133211,8 +134729,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 reactions: title: Reactions type: object @@ -133339,8 +134857,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -134134,7 +135652,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134150,7 +135669,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -134483,8 +136002,8 @@ x-webhooks: - state - locked - assignee - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -134564,7 +136083,7 @@ x-webhooks: type: string enum: - deleted - comment: &825 + comment: &837 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -134729,8 +136248,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -135520,7 +137039,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135536,7 +137056,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -135871,8 +137391,8 @@ x-webhooks: - state - locked - assignee - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -135952,7 +137472,7 @@ x-webhooks: type: string enum: - edited - changes: &853 + changes: &867 description: The changes to the comment. type: object properties: @@ -135964,9 +137484,9 @@ x-webhooks: type: string required: - from - comment: *825 - enterprise: *794 - installation: *795 + comment: *837 + enterprise: *806 + installation: *807 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -136759,7 +138279,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136775,7 +138296,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -137108,8 +138629,8 @@ x-webhooks: - state - locked - assignee - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -137193,15 +138714,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *180 + blocked_issue: *184 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *180 - blocking_issue_repo: *64 - installation: *795 - organization: *796 - repository: *797 + blocking_issue: *184 + blocking_issue_repo: *66 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -137289,15 +138810,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *180 + blocked_issue: *184 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *180 - blocking_issue_repo: *64 - installation: *795 - organization: *796 - repository: *797 + blocking_issue: *184 + blocking_issue_repo: *66 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -137384,15 +138905,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *180 - blocked_issue_repo: *64 + blocked_issue: *184 + blocked_issue_repo: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *180 - installation: *795 - organization: *796 - repository: *797 + blocking_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -137480,15 +139001,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *180 - blocked_issue_repo: *64 + blocked_issue: *184 + blocked_issue_repo: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *180 - installation: *795 - organization: *796 - repository: *797 + blocking_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -137573,10 +139094,10 @@ x-webhooks: type: string enum: - assigned - assignee: *821 - enterprise: *794 - installation: *795 - issue: &828 + assignee: *833 + enterprise: *806 + installation: *807 + issue: &840 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -138365,7 +139886,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138381,7 +139903,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -138482,8 +140004,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -138563,8 +140085,8 @@ x-webhooks: type: string enum: - closed - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -139358,7 +140880,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139374,7 +140897,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -139610,8 +141133,8 @@ x-webhooks: required: - state - closed_at - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -139690,8 +141213,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -140476,7 +141999,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140492,7 +142016,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -140592,8 +142116,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -140672,8 +142196,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -141480,7 +143004,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141496,7 +143021,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -141575,7 +143100,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &826 + milestone: &838 title: Milestone description: A collection of related issues and pull requests. type: object @@ -141713,8 +143238,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -141813,8 +143338,8 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -142603,7 +144128,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142616,7 +144142,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *316 + type: *326 title: description: Title of the issue type: string @@ -142720,9 +144246,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *820 - organization: *796 - repository: *797 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -142802,8 +144328,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -143591,7 +145117,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143604,7 +145131,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *316 + type: *326 title: description: Title of the issue type: string @@ -143708,9 +145235,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *820 - organization: *796 - repository: *797 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -143790,8 +145317,8 @@ x-webhooks: type: string enum: - locked - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -144603,7 +146130,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144616,7 +146144,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *316 + type: *326 title: description: Title of the issue type: string @@ -144697,8 +146225,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -144777,8 +146305,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -145584,7 +147112,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145600,7 +147129,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -145678,9 +147207,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *826 - organization: *796 - repository: *797 + milestone: *838 + organization: *808 + repository: *809 sender: *4 required: - action @@ -146548,7 +148077,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146641,7 +148171,7 @@ x-webhooks: required: - login - id - type: *316 + type: *326 required: - id - number @@ -147110,8 +148640,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -147900,7 +149430,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147916,7 +149447,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -148016,8 +149547,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -148097,9 +149628,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *794 - installation: *795 - issue: &827 + enterprise: *806 + installation: *807 + issue: &839 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -148882,7 +150413,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148898,7 +150430,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -148998,8 +150530,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -149078,8 +150610,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149889,7 +151421,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149983,9 +151516,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *316 - organization: *796 - repository: *797 + type: *326 + organization: *808 + repository: *809 sender: *4 required: - action @@ -150851,7 +152384,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150867,7 +152401,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -151435,11 +152969,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *794 - installation: *795 - issue: *827 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *839 + organization: *808 + repository: *809 sender: *4 required: - action @@ -151519,12 +153053,12 @@ x-webhooks: type: string enum: - typed - enterprise: *794 - installation: *795 - issue: *828 - type: *316 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *840 + type: *326 + organization: *808 + repository: *809 sender: *4 required: - action @@ -151605,7 +153139,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &856 + assignee: &870 title: User type: object nullable: true @@ -151675,11 +153209,11 @@ x-webhooks: required: - login - id - enterprise: *794 - installation: *795 - issue: *828 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *840 + organization: *808 + repository: *809 sender: *4 required: - action @@ -151758,12 +153292,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *794 - installation: *795 - issue: *828 - label: *820 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *840 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -151843,8 +153377,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152654,7 +154188,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152670,7 +154205,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -152748,8 +154283,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -152829,11 +154364,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *794 - installation: *795 - issue: *827 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *839 + organization: *808 + repository: *809 sender: *4 required: - action @@ -152912,12 +154447,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *794 - installation: *795 - issue: *828 - type: *316 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *840 + type: *326 + organization: *808 + repository: *809 sender: *4 required: - action @@ -152997,11 +154532,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - label: *820 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -153079,11 +154614,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - label: *820 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -153193,11 +154728,11 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - label: *820 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -153279,9 +154814,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *794 - installation: *795 - marketplace_purchase: &829 + enterprise: *806 + installation: *807 + marketplace_purchase: &841 title: Marketplace Purchase type: object required: @@ -153364,8 +154899,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *796 - previous_marketplace_purchase: &830 + organization: *808 + previous_marketplace_purchase: &842 title: Marketplace Purchase type: object properties: @@ -153445,7 +154980,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *797 + repository: *809 sender: *4 required: - action @@ -153525,10 +155060,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *794 - installation: *795 - marketplace_purchase: *829 - organization: *796 + enterprise: *806 + installation: *807 + marketplace_purchase: *841 + organization: *808 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -153611,7 +155146,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *797 + repository: *809 sender: *4 required: - action @@ -153693,10 +155228,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *794 - installation: *795 - marketplace_purchase: *829 - organization: *796 + enterprise: *806 + installation: *807 + marketplace_purchase: *841 + organization: *808 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -153778,7 +155313,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *797 + repository: *809 sender: *4 required: - action @@ -153859,8 +155394,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 marketplace_purchase: title: Marketplace Purchase type: object @@ -153942,9 +155477,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *796 - previous_marketplace_purchase: *830 - repository: *797 + organization: *808 + previous_marketplace_purchase: *842 + repository: *809 sender: *4 required: - action @@ -154024,12 +155559,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *794 - installation: *795 - marketplace_purchase: *829 - organization: *796 - previous_marketplace_purchase: *830 - repository: *797 + enterprise: *806 + installation: *807 + marketplace_purchase: *841 + organization: *808 + previous_marketplace_purchase: *842 + repository: *809 sender: *4 required: - action @@ -154131,11 +155666,11 @@ x-webhooks: type: string required: - to - enterprise: *794 - installation: *795 - member: *821 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + member: *833 + organization: *808 + repository: *809 sender: *4 required: - action @@ -154235,11 +155770,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *794 - installation: *795 - member: *821 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + member: *833 + organization: *808 + repository: *809 sender: *4 required: - action @@ -154318,11 +155853,11 @@ x-webhooks: type: string enum: - removed - enterprise: *794 - installation: *795 - member: *821 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + member: *833 + organization: *808 + repository: *809 sender: *4 required: - action @@ -154400,11 +155935,11 @@ x-webhooks: type: string enum: - added - enterprise: *794 - installation: *795 - member: *821 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + member: *833 + organization: *808 + repository: *809 scope: description: The scope of the membership. Currently, can only be `team`. @@ -154480,7 +156015,7 @@ x-webhooks: required: - login - id - team: &831 + team: &843 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -154670,11 +156205,11 @@ x-webhooks: type: string enum: - removed - enterprise: *794 - installation: *795 - member: *821 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + member: *833 + organization: *808 + repository: *809 scope: description: The scope of the membership. Currently, can only be `team`. @@ -154751,7 +156286,7 @@ x-webhooks: required: - login - id - team: *831 + team: *843 required: - action - scope @@ -154833,8 +156368,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *795 - merge_group: &833 + installation: *807 + merge_group: &845 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -154853,15 +156388,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *832 + head_commit: *844 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -154947,10 +156482,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *795 - merge_group: *833 - organization: *796 - repository: *797 + installation: *807 + merge_group: *845 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155023,7 +156558,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 + enterprise: *806 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -155132,16 +156667,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *795 - organization: *796 + installation: *807 + organization: *808 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *834 - required: *835 + properties: *846 + required: *847 nullable: true sender: *4 required: @@ -155222,11 +156757,11 @@ x-webhooks: type: string enum: - closed - enterprise: *794 - installation: *795 - milestone: *826 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + milestone: *838 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155305,9 +156840,9 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - milestone: &836 + enterprise: *806 + installation: *807 + milestone: &848 title: Milestone description: A collection of related issues and pull requests. type: object @@ -155444,8 +156979,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155524,11 +157059,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - milestone: *826 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + milestone: *838 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155638,11 +157173,11 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - milestone: *826 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + milestone: *838 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155722,11 +157257,11 @@ x-webhooks: type: string enum: - opened - enterprise: *794 - installation: *795 - milestone: *836 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + milestone: *848 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155805,11 +157340,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *821 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + blocked_user: *833 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155888,11 +157423,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *821 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + blocked_user: *833 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155971,9 +157506,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - membership: &837 + enterprise: *806 + installation: *807 + membership: &849 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -156080,8 +157615,8 @@ x-webhooks: - role - organization_url - user - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -156159,11 +157694,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *794 - installation: *795 - membership: *837 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + membership: *849 + organization: *808 + repository: *809 sender: *4 required: - action @@ -156242,8 +157777,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -156359,10 +157894,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 - user: *821 + user: *833 required: - action - invitation @@ -156440,11 +157975,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *794 - installation: *795 - membership: *837 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + membership: *849 + organization: *808 + repository: *809 sender: *4 required: - action @@ -156531,11 +158066,11 @@ x-webhooks: properties: from: type: string - enterprise: *794 - installation: *795 - membership: *837 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + membership: *849 + organization: *808 + repository: *809 sender: *4 required: - action @@ -156611,9 +158146,9 @@ x-webhooks: type: string enum: - published - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 package: description: Information about the package. type: object @@ -157112,7 +158647,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &838 + items: &850 title: Ruby Gems metadata type: object properties: @@ -157207,7 +158742,7 @@ x-webhooks: - owner - package_version - registry - repository: *797 + repository: *809 sender: *4 required: - action @@ -157283,9 +158818,9 @@ x-webhooks: type: string enum: - updated - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 package: description: Information about the package. type: object @@ -157638,7 +159173,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *838 + items: *850 source_url: type: string format: uri @@ -157708,7 +159243,7 @@ x-webhooks: - owner - package_version - registry - repository: *797 + repository: *809 sender: *4 required: - action @@ -157885,12 +159420,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *794 + enterprise: *806 id: type: integer - installation: *795 - organization: *796 - repository: *797 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - id @@ -157967,7 +159502,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &839 + personal_access_token_request: &851 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -158113,10 +159648,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *794 - organization: *796 + enterprise: *806 + organization: *808 sender: *4 - installation: *795 + installation: *807 required: - action - personal_access_token_request @@ -158193,11 +159728,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *839 - enterprise: *794 - organization: *796 + personal_access_token_request: *851 + enterprise: *806 + organization: *808 sender: *4 - installation: *795 + installation: *807 required: - action - personal_access_token_request @@ -158273,11 +159808,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *839 - enterprise: *794 - organization: *796 + personal_access_token_request: *851 + enterprise: *806 + organization: *808 sender: *4 - installation: *795 + installation: *807 required: - action - personal_access_token_request @@ -158352,11 +159887,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *839 - organization: *796 - enterprise: *794 + personal_access_token_request: *851 + organization: *808 + enterprise: *806 sender: *4 - installation: *795 + installation: *807 required: - action - personal_access_token_request @@ -158461,7 +159996,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *840 + last_response: *852 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -158493,8 +160028,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 zen: description: Random string of GitHub zen. @@ -158739,10 +160274,10 @@ x-webhooks: - from required: - note - enterprise: *794 - installation: *795 - organization: *796 - project_card: &841 + enterprise: *806 + installation: *807 + organization: *808 + project_card: &853 title: Project Card type: object properties: @@ -158861,7 +160396,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *797 + repository: *809 sender: *4 required: - action @@ -158942,11 +160477,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - project_card: *841 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project_card: *853 + repository: *809 sender: *4 required: - action @@ -159026,9 +160561,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 project_card: title: Project Card type: object @@ -159156,8 +160691,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *834 - required: *835 + properties: *846 + required: *847 nullable: true sender: *4 required: @@ -159251,11 +160786,11 @@ x-webhooks: - from required: - note - enterprise: *794 - installation: *795 - organization: *796 - project_card: *841 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project_card: *853 + repository: *809 sender: *4 required: - action @@ -159349,9 +160884,9 @@ x-webhooks: - from required: - column_id - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 project_card: allOf: - title: Project Card @@ -159541,7 +161076,7 @@ x-webhooks: type: string required: - after_id - repository: *797 + repository: *809 sender: *4 required: - action @@ -159621,10 +161156,10 @@ x-webhooks: type: string enum: - closed - enterprise: *794 - installation: *795 - organization: *796 - project: &843 + enterprise: *806 + installation: *807 + organization: *808 + project: &855 title: Project type: object properties: @@ -159748,7 +161283,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *797 + repository: *809 sender: *4 required: - action @@ -159828,10 +161363,10 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - project_column: &842 + enterprise: *806 + installation: *807 + organization: *808 + project_column: &854 title: Project Column type: object properties: @@ -159870,7 +161405,7 @@ x-webhooks: - name - created_at - updated_at - repository: *797 + repository: *809 sender: *4 required: - action @@ -159949,18 +161484,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - project_column: *842 + enterprise: *806 + installation: *807 + organization: *808 + project_column: *854 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *834 - required: *835 + properties: *846 + required: *847 nullable: true sender: *4 required: @@ -160050,11 +161585,11 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - organization: *796 - project_column: *842 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project_column: *854 + repository: *809 sender: *4 required: - action @@ -160134,11 +161669,11 @@ x-webhooks: type: string enum: - moved - enterprise: *794 - installation: *795 - organization: *796 - project_column: *842 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project_column: *854 + repository: *809 sender: *4 required: - action @@ -160218,11 +161753,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - project: *843 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project: *855 + repository: *809 sender: *4 required: - action @@ -160302,18 +161837,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - project: *843 + enterprise: *806 + installation: *807 + organization: *808 + project: *855 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *834 - required: *835 + properties: *846 + required: *847 nullable: true sender: *4 required: @@ -160415,11 +161950,11 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - organization: *796 - project: *843 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project: *855 + repository: *809 sender: *4 required: - action @@ -160498,11 +162033,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *794 - installation: *795 - organization: *796 - project: *843 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project: *855 + repository: *809 sender: *4 required: - action @@ -160583,9 +162118,9 @@ x-webhooks: type: string enum: - closed - installation: *795 - organization: *796 - projects_v2: &844 + installation: *807 + organization: *808 + projects_v2: &856 title: Projects v2 Project description: A projects v2 project type: object @@ -160633,6 +162168,62 @@ x-webhooks: properties: *20 required: *21 nullable: true + state: + type: string + enum: + - open + - closed + latest_status_update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: &861 + id: + type: number + node_id: + type: string + project_node_id: + type: string + creator: *4 + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + start_date: + type: string + format: date + example: '2022-04-28' + target_date: + type: string + format: date + example: '2022-04-28' + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: &862 + - id + - node_id + - created_at + - updated_at + nullable: true + is_template: + type: boolean + description: Whether this project is a template required: - id - node_id @@ -160728,9 +162319,9 @@ x-webhooks: type: string enum: - created - installation: *795 - organization: *796 - projects_v2: *844 + installation: *807 + organization: *808 + projects_v2: *856 sender: *4 required: - action @@ -160811,9 +162402,9 @@ x-webhooks: type: string enum: - deleted - installation: *795 - organization: *796 - projects_v2: *844 + installation: *807 + organization: *808 + projects_v2: *856 sender: *4 required: - action @@ -160930,9 +162521,9 @@ x-webhooks: type: string to: type: string - installation: *795 - organization: *796 - projects_v2: *844 + installation: *807 + organization: *808 + projects_v2: *856 sender: *4 required: - action @@ -161015,7 +162606,7 @@ x-webhooks: type: string enum: - archived - changes: &848 + changes: &860 type: object properties: archived_at: @@ -161029,9 +162620,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *795 - organization: *796 - projects_v2_item: &845 + installation: *807 + organization: *808 + projects_v2_item: &857 title: Projects v2 Item description: An item belonging to a project type: object @@ -161165,9 +162756,9 @@ x-webhooks: nullable: true to: type: string - installation: *795 - organization: *796 - projects_v2_item: *845 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161249,9 +162840,9 @@ x-webhooks: type: string enum: - created - installation: *795 - organization: *796 - projects_v2_item: *845 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161332,9 +162923,9 @@ x-webhooks: type: string enum: - deleted - installation: *795 - organization: *796 - projects_v2_item: *845 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161440,7 +163031,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &846 + - &858 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -161458,7 +163049,7 @@ x-webhooks: required: - id - name - - &847 + - &859 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -161481,8 +163072,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *846 - - *847 + - *858 + - *859 required: - field_value - type: object @@ -161498,9 +163089,9 @@ x-webhooks: nullable: true required: - body - installation: *795 - organization: *796 - projects_v2_item: *845 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161595,9 +163186,9 @@ x-webhooks: to: type: string nullable: true - installation: *795 - organization: *796 - projects_v2_item: *845 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161680,10 +163271,10 @@ x-webhooks: type: string enum: - restored - changes: *848 - installation: *795 - organization: *796 - projects_v2_item: *845 + changes: *860 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161765,9 +163356,9 @@ x-webhooks: type: string enum: - reopened - installation: *795 - organization: *796 - projects_v2: *844 + installation: *807 + organization: *808 + projects_v2: *856 sender: *4 required: - action @@ -161848,55 +163439,14 @@ x-webhooks: type: string enum: - created - installation: *795 - organization: *796 - projects_v2_status_update: &849 + installation: *807 + organization: *808 + projects_v2_status_update: &863 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: - id: - type: number - node_id: - type: string - project_node_id: - type: string - creator: *4 - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - status: - type: string - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - nullable: true - start_date: - type: string - format: date - example: '2022-04-28' - target_date: - type: string - format: date - example: '2022-04-28' - body: - description: Body of the status update - example: The project is off to a great start! - type: string - nullable: true - required: - - id - - node_id - - created_at - - updated_at + properties: *861 + required: *862 sender: *4 required: - action @@ -161977,9 +163527,9 @@ x-webhooks: type: string enum: - deleted - installation: *795 - organization: *796 - projects_v2_status_update: *849 + installation: *807 + organization: *808 + projects_v2_status_update: *863 sender: *4 required: - action @@ -162115,9 +163665,9 @@ x-webhooks: type: string format: date nullable: true - installation: *795 - organization: *796 - projects_v2_status_update: *849 + installation: *807 + organization: *808 + projects_v2_status_update: *863 sender: *4 required: - action @@ -162188,10 +163738,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - repository @@ -162268,13 +163818,13 @@ x-webhooks: type: string enum: - assigned - assignee: *821 - enterprise: *794 - installation: *795 - number: &850 + assignee: *833 + enterprise: *806 + installation: *807 + number: &864 description: The pull request number. type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -164557,7 +166107,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -164639,11 +166189,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -166921,7 +168471,7 @@ x-webhooks: - draft reason: type: string - repository: *797 + repository: *809 sender: *4 required: - action @@ -167003,11 +168553,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -169285,7 +170835,7 @@ x-webhooks: - draft reason: type: string - repository: *797 + repository: *809 sender: *4 required: - action @@ -169367,13 +170917,13 @@ x-webhooks: type: string enum: - closed - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: &851 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: &865 allOf: - - *649 + - *661 - type: object properties: allow_auto_merge: @@ -169435,7 +170985,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *797 + repository: *809 sender: *4 required: - action @@ -169516,12 +171066,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: *851 - repository: *797 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: *865 + repository: *809 sender: *4 required: - action @@ -169601,11 +171151,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *794 - milestone: *632 - number: *850 - organization: *796 - pull_request: &852 + enterprise: *806 + milestone: *644 + number: *864 + organization: *808 + pull_request: &866 title: Pull Request type: object properties: @@ -171868,7 +173418,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -171947,11 +173497,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -174233,7 +175783,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *797 + repository: *809 sender: *4 required: - action @@ -174357,12 +175907,12 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: *851 - repository: *797 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: *865 + repository: *809 sender: *4 required: - action @@ -174442,11 +175992,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -176713,7 +178263,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -176793,11 +178343,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *794 - installation: *795 - label: *820 - number: *850 - organization: *796 + enterprise: *806 + installation: *807 + label: *832 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -179079,7 +180629,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -179160,10 +180710,10 @@ x-webhooks: type: string enum: - locked - enterprise: *794 - installation: *795 - number: *850 - organization: *796 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -181443,7 +182993,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -181523,12 +183073,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *794 - milestone: *632 - number: *850 - organization: *796 - pull_request: *852 - repository: *797 + enterprise: *806 + milestone: *644 + number: *864 + organization: *808 + pull_request: *866 + repository: *809 sender: *4 required: - action @@ -181607,12 +183157,12 @@ x-webhooks: type: string enum: - opened - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: *851 - repository: *797 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: *865 + repository: *809 sender: *4 required: - action @@ -181693,12 +183243,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: *851 - repository: *797 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: *865 + repository: *809 sender: *4 required: - action @@ -181778,12 +183328,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: *851 - repository: *797 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: *865 + repository: *809 sender: *4 required: - action @@ -182149,9 +183699,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: type: object properties: @@ -184321,7 +185871,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *797 + repository: *809 sender: *4 required: - action @@ -184401,7 +185951,7 @@ x-webhooks: type: string enum: - deleted - comment: &854 + comment: &868 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -184686,9 +186236,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: type: object properties: @@ -186846,7 +188396,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *797 + repository: *809 sender: *4 required: - action @@ -186926,11 +188476,11 @@ x-webhooks: type: string enum: - edited - changes: *853 - comment: *854 - enterprise: *794 - installation: *795 - organization: *796 + changes: *867 + comment: *868 + enterprise: *806 + installation: *807 + organization: *808 pull_request: type: object properties: @@ -189091,7 +190641,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *797 + repository: *809 sender: *4 required: - action @@ -189172,9 +190722,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: title: Simple Pull Request type: object @@ -191347,7 +192897,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *797 + repository: *809 review: description: The review that was affected. type: object @@ -191590,9 +193140,9 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: title: Simple Pull Request type: object @@ -193646,8 +195196,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *797 - review: &855 + repository: *809 + review: &869 description: The review that was affected. type: object properties: @@ -193876,12 +195426,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: description: The pull request number. type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -196164,7 +197714,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 requested_reviewer: title: User type: object @@ -196248,12 +197798,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: description: The pull request number. type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -198543,7 +200093,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 requested_team: title: Team description: Groups of organization members that gives permissions @@ -198735,12 +200285,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: description: The pull request number. type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -201025,7 +202575,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 requested_reviewer: title: User type: object @@ -201110,12 +202660,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: description: The pull request number. type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -203391,7 +204941,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 requested_team: title: Team description: Groups of organization members that gives permissions @@ -203572,9 +205122,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: title: Simple Pull Request type: object @@ -205749,8 +207299,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *797 - review: *855 + repository: *809 + review: *869 sender: *4 required: - action @@ -205830,9 +207380,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: title: Simple Pull Request type: object @@ -207902,7 +209452,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *797 + repository: *809 sender: *4 thread: type: object @@ -208285,9 +209835,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: title: Simple Pull Request type: object @@ -210343,7 +211893,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *797 + repository: *809 sender: *4 thread: type: object @@ -210729,10 +212279,10 @@ x-webhooks: type: string before: type: string - enterprise: *794 - installation: *795 - number: *850 - organization: *796 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -213003,7 +214553,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -213085,11 +214635,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *856 - enterprise: *794 - installation: *795 - number: *850 - organization: *796 + assignee: *870 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -215372,7 +216922,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -215451,11 +217001,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *794 - installation: *795 - label: *820 - number: *850 - organization: *796 + enterprise: *806 + installation: *807 + label: *832 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -217728,7 +219278,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -217809,10 +219359,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *794 - installation: *795 - number: *850 - organization: *796 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -220077,7 +221627,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -220277,7 +221827,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *794 + enterprise: *806 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -220369,8 +221919,8 @@ x-webhooks: - url - author - committer - installation: *795 - organization: *796 + installation: *807 + organization: *808 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -220945,9 +222495,9 @@ x-webhooks: type: string enum: - published - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 registry_package: type: object properties: @@ -221393,7 +222943,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *838 + items: *850 summary: type: string tag_name: @@ -221447,7 +222997,7 @@ x-webhooks: - owner - package_version - registry - repository: *797 + repository: *809 sender: *4 required: - action @@ -221525,9 +223075,9 @@ x-webhooks: type: string enum: - updated - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 registry_package: type: object properties: @@ -221835,7 +223385,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *838 + items: *850 summary: type: string tag_name: @@ -221884,7 +223434,7 @@ x-webhooks: - owner - package_version - registry - repository: *797 + repository: *809 sender: *4 required: - action @@ -221961,10 +223511,10 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - release: &857 + enterprise: *806 + installation: *807 + organization: *808 + release: &871 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -222277,7 +223827,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *797 + repository: *809 sender: *4 required: - action @@ -222354,11 +223904,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - release: *857 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + release: *871 + repository: *809 sender: *4 required: - action @@ -222475,11 +224025,11 @@ x-webhooks: type: boolean required: - to - enterprise: *794 - installation: *795 - organization: *796 - release: *857 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + release: *871 + repository: *809 sender: *4 required: - action @@ -222557,9 +224107,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -222876,7 +224426,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *797 + repository: *809 sender: *4 required: - action @@ -222952,10 +224502,10 @@ x-webhooks: type: string enum: - published - enterprise: *794 - installation: *795 - organization: *796 - release: &858 + enterprise: *806 + installation: *807 + organization: *808 + release: &872 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -223269,7 +224819,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *797 + repository: *809 sender: *4 required: - action @@ -223345,11 +224895,11 @@ x-webhooks: type: string enum: - released - enterprise: *794 - installation: *795 - organization: *796 - release: *857 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + release: *871 + repository: *809 sender: *4 required: - action @@ -223425,11 +224975,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *794 - installation: *795 - organization: *796 - release: *858 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + release: *872 + repository: *809 sender: *4 required: - action @@ -223505,11 +225055,11 @@ x-webhooks: type: string enum: - published - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - repository_advisory: *701 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + repository_advisory: *713 sender: *4 required: - action @@ -223585,11 +225135,11 @@ x-webhooks: type: string enum: - reported - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - repository_advisory: *701 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + repository_advisory: *713 sender: *4 required: - action @@ -223665,10 +225215,10 @@ x-webhooks: type: string enum: - archived - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -223745,10 +225295,10 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -223826,10 +225376,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -223913,10 +225463,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -224028,10 +225578,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -224103,10 +225653,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 status: type: string @@ -224187,10 +225737,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -224267,10 +225817,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -224364,10 +225914,10 @@ x-webhooks: - name required: - repository - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -224447,11 +225997,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - repository_ruleset: *152 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + repository_ruleset: *154 sender: *4 required: - action @@ -224529,11 +226079,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - repository_ruleset: *152 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + repository_ruleset: *154 sender: *4 required: - action @@ -224611,11 +226161,11 @@ x-webhooks: type: string enum: - edited - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - repository_ruleset: *152 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + repository_ruleset: *154 changes: type: object properties: @@ -224634,16 +226184,16 @@ x-webhooks: properties: added: type: array - items: *126 + items: *128 deleted: type: array - items: *126 + items: *128 updated: type: array items: type: object properties: - condition: *126 + condition: *128 changes: type: object properties: @@ -224676,16 +226226,16 @@ x-webhooks: properties: added: type: array - items: *669 + items: *681 deleted: type: array - items: *669 + items: *681 updated: type: array items: type: object properties: - rule: *669 + rule: *681 changes: type: object properties: @@ -224919,10 +226469,10 @@ x-webhooks: - from required: - owner - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225000,10 +226550,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225081,7 +226631,7 @@ x-webhooks: type: string enum: - create - alert: &859 + alert: &873 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -225202,10 +226752,10 @@ x-webhooks: type: string enum: - open - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225411,10 +226961,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225492,11 +227042,11 @@ x-webhooks: type: string enum: - reopen - alert: *859 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + alert: *873 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225695,10 +227245,10 @@ x-webhooks: enum: - fixed - open - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225776,11 +227326,11 @@ x-webhooks: type: string enum: - created - alert: &860 + alert: &874 type: object properties: - number: *103 - created_at: *110 + number: *105 + created_at: *112 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -225788,8 +227338,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *108 - html_url: *109 + url: *110 + html_url: *111 locations_url: type: string format: uri @@ -225887,10 +227437,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225971,11 +227521,11 @@ x-webhooks: type: string enum: - created - alert: *860 - installation: *795 - location: *861 - organization: *796 - repository: *797 + alert: *874 + installation: *807 + location: *875 + organization: *808 + repository: *809 sender: *4 required: - location @@ -226213,11 +227763,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *860 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + alert: *874 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -226295,11 +227845,11 @@ x-webhooks: type: string enum: - reopened - alert: *860 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + alert: *874 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -226377,11 +227927,11 @@ x-webhooks: type: string enum: - resolved - alert: *860 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + alert: *874 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -226459,11 +228009,11 @@ x-webhooks: type: string enum: - validated - alert: *860 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + alert: *874 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -226589,10 +228139,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *797 - enterprise: *794 - installation: *795 - organization: *796 + repository: *809 + enterprise: *806 + installation: *807 + organization: *808 sender: *4 required: - action @@ -226670,11 +228220,11 @@ x-webhooks: type: string enum: - published - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - security_advisory: &862 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + security_advisory: &876 description: The details of the security advisory, including summary, description, and severity. type: object @@ -226690,7 +228240,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *105 + cvss_severities: *107 cwes: type: array items: @@ -226857,11 +228407,11 @@ x-webhooks: type: string enum: - updated - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - security_advisory: *862 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + security_advisory: *876 sender: *4 required: - action @@ -226934,10 +228484,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -226954,7 +228504,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *105 + cvss_severities: *107 cwes: type: array items: @@ -227121,11 +228671,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *355 - enterprise: *794 - installation: *795 - organization: *796 - repository: *420 + security_and_analysis: *365 + enterprise: *806 + installation: *807 + organization: *808 + repository: *432 sender: *4 required: - changes @@ -227203,12 +228753,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: &863 + sponsorship: &877 type: object properties: created_at: @@ -227509,12 +229059,12 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: *863 + sponsorship: *877 required: - action - sponsorship @@ -227602,12 +229152,12 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: *863 + sponsorship: *877 required: - action - changes @@ -227684,17 +229234,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &864 + effective_date: &878 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: *863 + sponsorship: *877 required: - action - sponsorship @@ -227768,7 +229318,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &865 + changes: &879 type: object properties: tier: @@ -227812,13 +229362,13 @@ x-webhooks: - from required: - tier - effective_date: *864 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + effective_date: *878 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: *863 + sponsorship: *877 required: - action - changes @@ -227895,13 +229445,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *865 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + changes: *879 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: *863 + sponsorship: *877 required: - action - changes @@ -227975,10 +229525,10 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -228061,10 +229611,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -228484,15 +230034,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *794 + enterprise: *806 id: description: The unique identifier of the status. type: integer - installation: *795 + installation: *807 name: type: string - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 sha: description: The Commit SHA. @@ -228601,15 +230151,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *180 - parent_issue_repo: *64 + parent_issue: *184 + parent_issue_repo: *66 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *180 - installation: *795 - organization: *796 - repository: *797 + sub_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -228693,15 +230243,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *180 - parent_issue_repo: *64 + parent_issue: *184 + parent_issue_repo: *66 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *180 - installation: *795 - organization: *796 - repository: *797 + sub_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -228785,15 +230335,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *180 - sub_issue_repo: *64 + sub_issue: *184 + sub_issue_repo: *66 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *180 - installation: *795 - organization: *796 - repository: *797 + parent_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -228877,15 +230427,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *180 - sub_issue_repo: *64 + sub_issue: *184 + sub_issue_repo: *66 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *180 - installation: *795 - organization: *796 - repository: *797 + parent_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -228962,12 +230512,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - team: &866 + team: &880 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -229157,9 +230707,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 repository: title: Repository description: A git repository @@ -229617,7 +231167,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *880 required: - action - team @@ -229693,9 +231243,9 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 repository: title: Repository description: A git repository @@ -230153,7 +231703,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *880 required: - action - team @@ -230230,9 +231780,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 repository: title: Repository description: A git repository @@ -230690,7 +232240,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *880 required: - action - team @@ -230834,9 +232384,9 @@ x-webhooks: - from required: - permissions - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 repository: title: Repository description: A git repository @@ -231294,7 +232844,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *880 required: - action - changes @@ -231372,9 +232922,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 repository: title: Repository description: A git repository @@ -231832,7 +233382,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *880 required: - action - team @@ -231908,10 +233458,10 @@ x-webhooks: type: string enum: - started - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -231984,16 +233534,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *794 + enterprise: *806 inputs: type: object nullable: true additionalProperties: true - installation: *795 - organization: *796 + installation: *807 + organization: *808 ref: type: string - repository: *797 + repository: *809 sender: *4 workflow: type: string @@ -232075,10 +233625,10 @@ x-webhooks: type: string enum: - completed - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 workflow_job: allOf: @@ -232315,7 +233865,7 @@ x-webhooks: type: string required: - conclusion - deployment: *555 + deployment: *567 required: - action - repository @@ -232394,10 +233944,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 workflow_job: allOf: @@ -232657,7 +234207,7 @@ x-webhooks: required: - status - steps - deployment: *555 + deployment: *567 required: - action - repository @@ -232736,10 +234286,10 @@ x-webhooks: type: string enum: - queued - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 workflow_job: type: object @@ -232874,7 +234424,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *555 + deployment: *567 required: - action - repository @@ -232953,10 +234503,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 workflow_job: type: object @@ -233092,7 +234642,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *555 + deployment: *567 required: - action - repository @@ -233172,12 +234722,12 @@ x-webhooks: type: string enum: - completed - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - workflow: *816 + workflow: *828 workflow_run: title: Workflow Run type: object @@ -234176,12 +235726,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - workflow: *816 + workflow: *828 workflow_run: title: Workflow Run type: object @@ -235165,12 +236715,12 @@ x-webhooks: type: string enum: - requested - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - workflow: *816 + workflow: *828 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index bd832a92ab..ef7b78401f 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -203,6 +203,10 @@ { "name": "credentials", "description": "Revoke compromised or leaked GitHub credentials." + }, + { + "name": "projects", + "description": "Endpoints to manage Projects using the REST API." } ], "servers": [ @@ -18861,6 +18865,781 @@ } } }, + "/enterprises/{enterprise}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an enterprise", + "description": "Gets artifact and log retention settings for an enterprise.", + "operationId": "enterprise-admin/get-artifact-and-log-retention-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the artifact and log retention settings", + "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": { + "summary": "Example response", + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "401": { + "description": "Authorization failure" + }, + "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": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for an enterprise", + "description": "Sets artifact and log retention settings for an enterprise.", + "operationId": "enterprise-admin/set-artifact-and-log-retention-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Successfully updated the artifact and log retention settings" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "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": { + "default": { + "summary": "Set retention to 100 days", + "value": { + "days": 100 + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for an enterprise", + "description": "Gets the fork PR contributor approval policy for an enterprise.", + "operationId": "enterprise-admin/get-fork-pr-contributor-approval-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an enterprise", + "description": "Sets the fork PR contributor approval policy for an enterprise.", + "operationId": "enterprise-admin/set-fork-pr-contributor-approval-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for an enterprise", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise.", + "operationId": "enterprise-admin/get-private-repo-fork-pr-workflows-settings", + "tags": [ + "enterprise-admin" + ], + "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-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "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 + } + } + } + } + } + }, + "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": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for an enterprise", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise.", + "operationId": "enterprise-admin/set-private-repo-fork-pr-workflows-settings", + "tags": [ + "enterprise-admin" + ], + "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-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/enterprises/{enterprise}/actions/permissions/organizations": { "get": { "summary": "List selected organizations enabled for GitHub Actions in an enterprise", @@ -19330,6 +20109,247 @@ } } }, + "/enterprises/{enterprise}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners permissions for an enterprise", + "description": "Gets the settings for whether organizations in the enterprise are allowed to manage self-hosted runners at the repository level.", + "operationId": "enterprise-admin/get-self-hosted-runners-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "disable_self_hosted_runners_for_all_orgs": { + "type": "boolean", + "description": "When true, repository-level runners will be disabled across all organizations in the enterprise" + } + }, + "required": [ + "disable_self_hosted_runners_for_all_orgs" + ] + }, + "examples": { + "default": { + "value": { + "disable_self_hosted_runners_for_all_orgs": 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": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set self-hosted runners permissions for an enterprise", + "description": "Sets the settings for whether organizations in the enterprise are allowed to manage self-hosted runners at the repository level.", + "operationId": "enterprise-admin/set-self-hosted-runners-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "disable_self_hosted_runners_for_all_orgs": { + "type": "boolean", + "description": "When true, repository-level runners will be disabled across all organizations in the enterprise" + } + }, + "required": [ + "disable_self_hosted_runners_for_all_orgs" + ] + }, + "examples": { + "default": { + "summary": "Disable repository-level runners across all organizations", + "value": { + "disable_self_hosted_runners_for_all_orgs": true + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/enterprises/{enterprise}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an enterprise", @@ -36676,7 +37696,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -51735,159 +52755,23 @@ } } }, - "/enterprises/{enterprise}/settings/billing/actions": { + "/enterprises/{enterprise}/secret-scanning/pattern-configurations": { "get": { - "summary": "Get GitHub Actions billing for an enterprise", - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nThe authenticated user must be an enterprise admin.\n\n> [!NOTE]\n> This endpoint is available to enterprise customers who are using the legacy billing platform.", - "operationId": "billing/get-github-actions-billing-ghe", + "summary": "List enterprise pattern configurations", + "description": "Lists the secret scanning pattern configurations for an enterprise.\n\nPersonal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ - "billing" + "secret-scanning" ], + "operationId": "secret-scanning/list-enterprise-pattern-configs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-actions-billing-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total_minutes_used": { - "type": "integer", - "description": "The sum of the free and paid GitHub Actions minutes used." - }, - "total_paid_minutes_used": { - "type": "integer", - "description": "The total paid GitHub Actions minutes used." - }, - "included_minutes": { - "type": "integer", - "description": "The amount of free GitHub Actions minutes available." - }, - "minutes_used_breakdown": { - "type": "object", - "properties": { - "UBUNTU": { - "type": "integer", - "description": "Total minutes used on Ubuntu runner machines." - }, - "MACOS": { - "type": "integer", - "description": "Total minutes used on macOS runner machines." - }, - "WINDOWS": { - "type": "integer", - "description": "Total minutes used on Windows runner machines." - }, - "ubuntu_4_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 4 core runner machines." - }, - "ubuntu_8_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 8 core runner machines." - }, - "ubuntu_16_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 16 core runner machines." - }, - "ubuntu_32_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 32 core runner machines." - }, - "ubuntu_64_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 64 core runner machines." - }, - "windows_4_core": { - "type": "integer", - "description": "Total minutes used on Windows 4 core runner machines." - }, - "windows_8_core": { - "type": "integer", - "description": "Total minutes used on Windows 8 core runner machines." - }, - "windows_16_core": { - "type": "integer", - "description": "Total minutes used on Windows 16 core runner machines." - }, - "windows_32_core": { - "type": "integer", - "description": "Total minutes used on Windows 32 core runner machines." - }, - "windows_64_core": { - "type": "integer", - "description": "Total minutes used on Windows 64 core runner machines." - }, - "macos_12_core": { - "type": "integer", - "description": "Total minutes used on macOS 12 core runner machines." - }, - "total": { - "type": "integer", - "description": "Total minutes used on all runner machines." - } - } - } - }, - "required": [ - "total_minutes_used", - "total_paid_minutes_used", - "included_minutes", - "minutes_used_breakdown" - ] - }, - "examples": { - "default": { - "value": { - "total_minutes_used": 305, - "total_paid_minutes_used": 0, - "included_minutes": 3000, - "minutes_used_breakdown": { - "UBUNTU": 205, - "MACOS": 10, - "WINDOWS": 90 - } - } - } - } - } - } - } + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations" }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "billing" - } - } - }, - "/enterprises/{enterprise}/settings/billing/advanced-security": { - "get": { - "summary": "Get GitHub Advanced Security active committers for an enterprise", - "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.", - "tags": [ - "billing" - ], - "operationId": "billing/get-github-advanced-security-billing-ghe", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" }, "parameters": [ { @@ -51898,244 +52782,167 @@ "schema": { "type": "string" } - }, - { - "name": "advanced_security_product", - "in": "query", - "description": "The security product to get GitHub Advanced Security active committers for.\n\nFor standalone Code Scanning or Secret Protection products, this parameter is required to specify which product you want committer information for. For other plans this parameter cannot be used.\n", - "required": false, - "schema": { - "type": "string", - "enum": [ - "code_security", - "secret_protection" - ] - } - }, - { - "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": "Success", + "description": "Response", "content": { "application/json": { "schema": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", "type": "object", "properties": { - "total_advanced_security_committers": { - "type": "integer", - "example": 25 - }, - "total_count": { - "type": "integer", - "example": 2 - }, - "maximum_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" - }, - "purchased_advanced_security_committers": { - "type": "integer", - "example": 4, - "description": "The total number of GitHub Advanced Security licences purchased" + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true }, - "repositories": { + "provider_pattern_overrides": { "type": "array", + "description": "Overrides for partner patterns.", "items": { "type": "object", "properties": { - "name": { + "token_type": { "type": "string", - "example": "octocat/Hello-World" + "description": "The ID of the pattern." }, - "advanced_security_committers": { + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { "type": "integer", - "example": 25 + "description": "The total number of alerts generated by this pattern." }, - "advanced_security_committers_breakdown": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user_login": { - "type": "string" - }, - "last_pushed_date": { - "type": "string", - "example": "2021-11-03" - }, - "last_pushed_email": { - "type": "string", - "example": "monalisa@github.com" - } - }, - "required": [ - "user_login", - "last_pushed_date", - "last_pushed_email" - ] - } + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] } - }, - "required": [ - "name", - "advanced_security_committers", - "advanced_security_committers_breakdown" - ] - } - } - }, - "required": [ - "repositories" - ] - }, - "examples": { - "default": { - "value": { - "total_advanced_security_committers": 2, - "total_count": 2, - "maximum_advanced_security_committers": 4, - "purchased_advanced_security_committers": 4, - "repositories": [ - { - "name": "octocat-org/Hello-World", - "advanced_security_committers": 2, - "advanced_security_committers_breakdown": [ - { - "user_login": "octocat", - "last_pushed_date": "2021-11-03", - "last_pushed_email": "octocat@github.com" - }, - { - "user_login": "octokitten", - "last_pushed_date": "2021-10-25", - "last_pushed_email": "octokitten@github.com" - } - ] - }, - { - "name": "octocat-org/server", - "advanced_security_committers": 1, - "advanced_security_committers_breakdown": [ - { - "user_login": "octokitten", - "last_pushed_date": "2021-10-26", - "last_pushed_email": "octokitten@github.com" - } - ] } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "billing" - } - } - }, - "/enterprises/{enterprise}/settings/billing/cost-centers": { - "get": { - "summary": "Get all cost centers for an enterprise", - "description": "Gets a list of all the cost centers for an enterprise.", - "tags": [ - "billing" - ], - "operationId": "billing/get-all-cost-centers", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response when getting cost centers", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "costCenters": { + } + }, + "custom_pattern_overrides": { "type": "array", + "description": "Overrides for custom patterns defined by the organization.", "items": { "type": "object", "properties": { - "id": { + "token_type": { "type": "string", - "description": "ID of the cost center." + "description": "The ID of the pattern." }, - "name": { + "custom_pattern_version": { "type": "string", - "description": "Name of the cost center." + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true }, - "state": { + "slug": { "type": "string", - "description": "State of the cost center.", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", "enum": [ - "active", - "deleted" + "disabled", + "enabled" ] }, - "resources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of the resource." - }, - "name": { - "type": "string", - "description": "Name of the resource." - } - }, - "required": [ - "type", - "name" - ] - } + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] } - }, - "required": [ - "id", - "name", - "resources" - ] + } } } } @@ -52143,21 +52950,35 @@ "examples": { "default": { "value": { - "costCenters": [ + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ { - "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002", - "name": "Cost Center Name", - "state": "active", - "resources": [ - { - "type": "User", - "name": "Monalisa" - }, - { - "type": "Repo", - "name": "octocat/hello-world" - } - ] + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" } ] } @@ -52166,8 +52987,840 @@ } } }, - "400": { - "description": "Bad Request", + "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" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update enterprise pattern configurations", + "description": "Updates the secret scanning pattern configurations for an enterprise.\n\nPersonal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-enterprise-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, + "/enterprises/{enterprise}/settings/billing/actions": { + "get": { + "summary": "Get GitHub Actions billing for an enterprise", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nThe authenticated user must be an enterprise admin.\n\n> [!NOTE]\n> This endpoint is available to enterprise customers who are using the legacy billing platform.", + "operationId": "billing/get-github-actions-billing-ghe", + "tags": [ + "billing" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-actions-billing-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_minutes_used": { + "type": "integer", + "description": "The sum of the free and paid GitHub Actions minutes used." + }, + "total_paid_minutes_used": { + "type": "integer", + "description": "The total paid GitHub Actions minutes used." + }, + "included_minutes": { + "type": "integer", + "description": "The amount of free GitHub Actions minutes available." + }, + "minutes_used_breakdown": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "integer", + "description": "Total minutes used on Ubuntu runner machines." + }, + "MACOS": { + "type": "integer", + "description": "Total minutes used on macOS runner machines." + }, + "WINDOWS": { + "type": "integer", + "description": "Total minutes used on Windows runner machines." + }, + "ubuntu_4_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 4 core runner machines." + }, + "ubuntu_8_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 8 core runner machines." + }, + "ubuntu_16_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 16 core runner machines." + }, + "ubuntu_32_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 32 core runner machines." + }, + "ubuntu_64_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 64 core runner machines." + }, + "windows_4_core": { + "type": "integer", + "description": "Total minutes used on Windows 4 core runner machines." + }, + "windows_8_core": { + "type": "integer", + "description": "Total minutes used on Windows 8 core runner machines." + }, + "windows_16_core": { + "type": "integer", + "description": "Total minutes used on Windows 16 core runner machines." + }, + "windows_32_core": { + "type": "integer", + "description": "Total minutes used on Windows 32 core runner machines." + }, + "windows_64_core": { + "type": "integer", + "description": "Total minutes used on Windows 64 core runner machines." + }, + "macos_12_core": { + "type": "integer", + "description": "Total minutes used on macOS 12 core runner machines." + }, + "total": { + "type": "integer", + "description": "Total minutes used on all runner machines." + } + } + } + }, + "required": [ + "total_minutes_used", + "total_paid_minutes_used", + "included_minutes", + "minutes_used_breakdown" + ] + }, + "examples": { + "default": { + "value": { + "total_minutes_used": 305, + "total_paid_minutes_used": 0, + "included_minutes": 3000, + "minutes_used_breakdown": { + "UBUNTU": 205, + "MACOS": 10, + "WINDOWS": 90 + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" + } + } + }, + "/enterprises/{enterprise}/settings/billing/advanced-security": { + "get": { + "summary": "Get GitHub Advanced Security active committers for an enterprise", + "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-advanced-security-billing-ghe", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "advanced_security_product", + "in": "query", + "description": "The security product to get GitHub Advanced Security active committers for.\n\nFor standalone Code Scanning or Secret Protection products, this parameter is required to specify which product you want committer information for. For other plans this parameter cannot be used.\n", + "required": false, + "schema": { + "type": "string", + "enum": [ + "code_security", + "secret_protection" + ] + } + }, + { + "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": "Success", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_advanced_security_committers": { + "type": "integer", + "example": 25 + }, + "total_count": { + "type": "integer", + "example": 2 + }, + "maximum_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" + }, + "purchased_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences purchased" + }, + "repositories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "advanced_security_committers": { + "type": "integer", + "example": 25 + }, + "advanced_security_committers_breakdown": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user_login": { + "type": "string" + }, + "last_pushed_date": { + "type": "string", + "example": "2021-11-03" + }, + "last_pushed_email": { + "type": "string", + "example": "monalisa@github.com" + } + }, + "required": [ + "user_login", + "last_pushed_date", + "last_pushed_email" + ] + } + } + }, + "required": [ + "name", + "advanced_security_committers", + "advanced_security_committers_breakdown" + ] + } + } + }, + "required": [ + "repositories" + ] + }, + "examples": { + "default": { + "value": { + "total_advanced_security_committers": 2, + "total_count": 2, + "maximum_advanced_security_committers": 4, + "purchased_advanced_security_committers": 4, + "repositories": [ + { + "name": "octocat-org/Hello-World", + "advanced_security_committers": 2, + "advanced_security_committers_breakdown": [ + { + "user_login": "octocat", + "last_pushed_date": "2021-11-03", + "last_pushed_email": "octocat@github.com" + }, + { + "user_login": "octokitten", + "last_pushed_date": "2021-10-25", + "last_pushed_email": "octokitten@github.com" + } + ] + }, + { + "name": "octocat-org/server", + "advanced_security_committers": 1, + "advanced_security_committers_breakdown": [ + { + "user_login": "octokitten", + "last_pushed_date": "2021-10-26", + "last_pushed_email": "octokitten@github.com" + } + ] + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" + } + } + }, + "/enterprises/{enterprise}/settings/billing/cost-centers": { + "get": { + "summary": "Get all cost centers for an enterprise", + "description": "Gets a list of all the cost centers for an enterprise.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-cost-centers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response when getting cost centers", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "costCenters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the cost center." + }, + "name": { + "type": "string", + "description": "Name of the cost center." + }, + "state": { + "type": "string", + "description": "State of the cost center.", + "enum": [ + "active", + "deleted" + ] + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the resource." + }, + "name": { + "type": "string", + "description": "Name of the resource." + } + }, + "required": [ + "type", + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "resources" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "costCenters": [ + { + "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002", + "name": "Cost Center Name", + "state": "active", + "resources": [ + { + "type": "User", + "name": "Monalisa" + }, + { + "type": "Repo", + "name": "octocat/hello-world" + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -57216,6 +58869,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -72356,6 +74033,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -78132,6 +79833,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -82048,17 +83773,17 @@ "deprecated": true } }, - "/organizations/{org}/dependabot/repository-access": { + "/organizations/{org}/actions/permissions/artifact-and-log-retention": { "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.", + "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": [ - "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/permissions#get-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -82069,29 +83794,6 @@ "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": { @@ -82100,523 +83802,28 @@ "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": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal", - "nullable": true + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" }, - "accessible_repositories": { - "type": "array", - "items": { - "title": "Simple Repository", - "description": "A GitHub repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "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" - ], - "nullable": true - } + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" } }, - "additionalProperties": false + "required": [ + "days", + "maximum_allowed_days" + ] }, "examples": { - "default": { + "response": { + "summary": "Example response", "value": { - "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" - } - ] + "days": 90, + "maximum_allowed_days": 365 } } } @@ -82677,22 +83884,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } }, - "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```", + "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": [ - "dependabot" + "actions" ], - "operationId": "dependabot/update-repository-access-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/permissions#set-artifact-and-log-retention-settings-for-an-organization" }, "parameters": [ { @@ -82712,50 +83918,19 @@ "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." + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" } }, - "example": { - "repository_ids_to_add": [ - 123, - 456 - ], - "repository_ids_to_remove": [ - 789 - ] - } + "required": [ + "days" + ] }, "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", + "application/json": { "value": { - "repository_ids_to_remove": [ - 789 - ] + "days": 100 } } } @@ -82764,7 +83939,7 @@ }, "responses": { "204": { - "description": "Response" + "description": "No content" }, "403": { "description": "Forbidden", @@ -82817,77 +83992,9 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" - } - } - }, - "/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": [ - "dependabot" - ], - "operationId": "dependabot/set-repository-access-default-level", - "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" - }, - "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": { - "default_level": { - "type": "string", - "description": "The default repository access level for Dependabot updates.", - "enum": [ - "public", - "internal" - ], - "example": "internal" - } - }, - "required": [ - "default_level" - ] - }, - "examples": { - "204": { - "summary": "Example with a 'succeeded' status.", - "value": { - "default_level": "public" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -82912,14 +84019,18 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -82927,11 +84038,50 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -82940,24 +84090,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "dependabot", - "subcategory": "repository-access" + "category": "actions", + "subcategory": "permissions" } } }, - "/organizations/{org}/settings/billing/usage": { + "/organizations/{org}/actions/permissions/fork-pr-contributor-approval": { "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).\"", + "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": [ - "billing" + "actions" ], - "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" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" }, "parameters": [ { @@ -82968,144 +84117,42 @@ "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", + "description": "Response", "content": { "application/json": { "schema": { "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" - ] - } + "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": { - "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" - } - ] + "approval_policy": "first_time_contributors" } } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83127,45 +84174,44 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } + } + }, + "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": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -83190,14 +84236,18 @@ } } }, - "500": { - "description": "Internal Error", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -83205,33 +84255,83 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "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" } } } @@ -83239,24 +84339,23 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "billing", - "subcategory": "enhanced-billing" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}": { + "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos": { "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 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": [ - "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-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -83275,446 +84374,65 @@ "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", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true, - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "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", - "nullable": true - }, - "default_repository_branch": { - "type": "string", - "example": "main", - "nullable": true, - "description": "The default branch for repositories created in this organization." - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_delete_repositories": { - "type": "boolean", - "example": true - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "example": true - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "example": true - }, - "members_can_delete_issues": { - "type": "boolean", - "example": true - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "example": true - }, - "readers_can_create_discussions": { - "type": "boolean", - "example": true - }, - "members_can_create_teams": { - "type": "boolean", - "example": true - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { + "run_workflows_from_fork_pull_requests": { "type": "boolean", - "example": false, - "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.", - "deprecated": true + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "secret_scanning_push_protection_custom_link_enabled": { + "send_write_tokens_to_workflows": { "type": "boolean", - "example": false, - "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", - "example": "https://github.com/test-org/test-repo/blob/main/README.md", - "nullable": true, - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "secret_scanning_validity_checks_enabled": { + "send_secrets_and_variables": { "type": "boolean", - "example": false, - "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 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "deploy_keys_enabled_for_repositories": { + "require_approval_for_fork_pr_workflows": { "type": "boolean", - "example": false, - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } - }, - "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": { + "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 + "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": { + "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" } } } @@ -83749,22 +84467,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "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 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": [ - "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-private-repo-fork-pr-workflow-settings-for-an-organization" }, "parameters": [ { @@ -83778,176 +84495,40 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], "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", - "example": "\"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": { + "run_workflows_from_fork_pull_requests": { "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 + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." }, - "secret_scanning_push_protection_custom_link_enabled": { + "send_write_tokens_to_workflows": { "type": "boolean", - "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." }, - "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": { + "send_secrets_and_variables": { "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 + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." }, - "deploy_keys_enabled_for_repositories": { + "require_approval_for_fork_pr_workflows": { "type": "boolean", - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." } } }, "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" + "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 } } } @@ -83955,561 +84536,73 @@ } }, "responses": { - "200": { - "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": "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.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 + "message": { + "type": "string" }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "documentation_url": { + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true, - "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "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", - "nullable": true - }, - "default_repository_branch": { - "type": "string", - "example": "main", - "nullable": true, - "description": "The default branch for repositories created in this organization." - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_public_pages": { - "type": "boolean", - "example": true - }, - "members_can_create_private_pages": { - "type": "boolean", - "example": true - }, - "members_can_delete_repositories": { - "type": "boolean", - "example": true - }, - "members_can_change_repo_visibility": { - "type": "boolean", - "example": true - }, - "members_can_invite_outside_collaborators": { - "type": "boolean", - "example": true - }, - "members_can_delete_issues": { - "type": "boolean", - "example": true - }, - "display_commenter_full_name_setting_enabled": { - "type": "boolean", - "example": true - }, - "readers_can_create_discussions": { - "type": "boolean", - "example": true - }, - "members_can_create_teams": { - "type": "boolean", - "example": true - }, - "members_can_view_dependency_insights": { - "type": "boolean", - "example": true - }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependabot_security_updates_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "dependency_graph_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "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.", - "deprecated": true - }, - "secret_scanning_push_protection_custom_link_enabled": { - "type": "boolean", - "example": false, - "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", - "example": "https://github.com/test-org/test-repo/blob/main/README.md", - "nullable": true, - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." - }, - "secret_scanning_validity_checks_enabled": { - "type": "boolean", - "example": false, - "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 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "archived_at": { - "type": "string", - "format": "date-time", - "nullable": true + "type": "string" }, - "deploy_keys_enabled_for_repositories": { - "type": "boolean", - "example": false, - "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." - } - }, - "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 + "status": { + "type": "string" } } } } } }, - "422": { - "description": "Validation failed", + "404": { + "description": "Resource not found", "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -84517,11 +84610,50 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -84530,22 +84662,23 @@ } }, "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", + } + }, + "/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": [ - "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#get-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -84559,23 +84692,45 @@ } ], "responses": { - "202": { - "description": "Accepted", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "type": "object" + "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": { - "default": { - "value": null + "response": { + "summary": "Example response", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } } } } } }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -84600,8 +84755,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -84628,24 +84783,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "permissions" } - } - }, - "/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.", + }, + "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" ], - "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#set-self-hosted-runners-settings-for-an-organization" }, "parameters": [ { @@ -84658,67 +84810,207 @@ } } ], + "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": { - "200": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "total_active_caches_count": { - "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." + "message": { + "type": "string" }, - "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." + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } - }, - "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 + } + } + } + } + }, + "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" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "409": { + "description": "Conflict", + "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" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "cache" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/cache/usage-by-repository": { + "/organizations/{org}/actions/permissions/self-hosted-runners/repositories": { "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.", + "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" ], - "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#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" }, "parameters": [ { @@ -84756,304 +85048,739 @@ "application/json": { "schema": { "type": "object", - "required": [ - "total_count", - "repository_cache_usages" - ], "properties": { "total_count": { "type": "integer" }, - "repository_cache_usages": { + "repositories": { "type": "array", "items": { - "title": "Actions Cache Usage by repository", - "description": "GitHub Actions Cache Usage by repository.", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "full_name": { - "description": "The repository owner and name for the cache usage being shown.", + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { "type": "string", - "example": "octo-org/Hello-World" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "active_caches_size_in_bytes": { - "description": "The sum of the size in bytes of all the active cache items in the repository.", - "type": "integer", - "example": 2322142 + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" }, - "active_caches_count": { - "description": "The number of active caches in the repository.", - "type": "integer", - "example": 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": "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", + "full_name": { "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 + "example": "octocat/Hello-World" }, - "image_details": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", + "license": { + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "key": { "type": "string", - "example": "ubuntu-20.04" + "example": "mit" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "name": { + "type": "string", + "example": "MIT License" }, - "display_name": { - "description": "Display name for this image.", + "url": { "type": "string", - "example": 20.04 + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" }, - "source": { - "description": "The image provider.", + "spdx_id": { "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "id", - "size_gb", - "display_name", - "source" + "key", + "name", + "url", + "spdx_id", + "node_id" ], "nullable": true }, - "machine_size_details": { - "title": "Github-owned VM details.", - "description": "Provides details of a particular machine spec.", + "forks": { + "type": "integer" + }, + "permissions": { "type": "object", "properties": { - "id": { - "description": "The ID used for the `size` parameter when creating a new runner.", + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "example": "8-core" + "example": "octocat" }, - "cpu_cores": { - "description": "The number of cores.", + "id": { "type": "integer", - "example": 8 + "format": "int64", + "example": 1 }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "cpu_cores", - "memory_gb", - "storage_gb" + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "status": { - "description": "The status of the runner.", + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "platform": { - "description": "The operating system of the image.", + "description": { "type": "string", - "example": "linux-x64" + "example": "This your first repo!", + "nullable": true }, - "maximum_runners": { - "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { "type": "integer", - "default": 10, - "example": 5 + "example": 9 }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 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", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, "type": "boolean", "example": true }, - "public_ips": { - "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "topics": { "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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } + "type": "string" } }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": "string", "format": "date-time", - "example": "2022-10-09T23:39:01Z", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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", - "image_details", - "machine_size_details", - "status", - "public_ip_enabled", - "platform" + "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" ] } } @@ -85062,89 +85789,207 @@ "examples": { "default": { "value": { - "total_count": 2, - "runners": [ + "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 + "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 }, - "status": "Ready", - "maximum_runners": 10, - "public_ip_enabled": true, - "public_ips": [ - { - "enabled": true, - "prefix": "20.80.208.150", - "length": 31 - } + "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" ], - "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 + "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 }, - "machine_size_details": { - "id": "8-core", - "cpu_cores": 8, - "memory_gb": 32, - "storage_gb": 300 + "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" }, - "status": "Ready", - "maximum_runners": 20, - "public_ip_enabled": false, - "public_ips": [], - "last_active_on": "2023-04-26T15:23:37Z" + "forks": 1, + "open_issues": 1, + "watchers": 1 } ] } } } } - }, - "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 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/hosted-runners#create-a-github-hosted-runner-for-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": [ { @@ -85163,66 +86008,27 @@ "application/json": { "schema": { "type": "object", + "required": [ + "selected_repository_ids" + ], "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" + "selected_repository_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" } - }, - "required": [ - "name", - "image", - "size", - "runner_group_id" - ] + } }, "examples": { - "default": { + "application/json": { "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 + "selected_repository_ids": [ + 1, + 2, + 3 + ] } } } @@ -85230,336 +86036,149 @@ } }, "responses": { - "201": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 + "message": { + "type": "string" }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true + "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] + "url": { + "type": "string" }, "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": true + "documentation_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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } + "url": { + "type": "string" }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" + "status": { + "type": "string" } } } } } - } - }, - "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", + }, + "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", - "images" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "images": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", "type": "object", + "required": [ + "code" + ], "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" + "resource": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" + "field": { + "type": "string" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "message": { + "type": "string" }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 + "code": { + "type": "string" }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } ] } - }, - "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" + "subcategory": "permissions" } } }, - "/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", + "/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/hosted-runners#get-partner-images-for-github-hosted-runners-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": [ { @@ -85570,105 +86189,185 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", + "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" + } + } + } + } + } + }, + "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": [ - "total_count", - "images" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "images": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "title": "GitHub-hosted runner image details.", - "description": "Provides details of a hosted runner image", "type": "object", + "required": [ + "code" + ], "properties": { - "id": { - "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", - "type": "string", - "example": "ubuntu-20.04" + "resource": { + "type": "string" }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "linux-x64" + "field": { + "type": "string" }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 + "message": { + "type": "string" }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 + "code": { + "type": "string" }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } ] } - }, - "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" + "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", + }, + "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/hosted-runners#get-limits-on-github-hosted-runners-for-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": [ { @@ -85679,242 +86378,187 @@ "schema": { "type": "string" } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "No content" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "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.", - "example": 50 - }, - "current_usage": { - "type": "integer", - "description": "The current number of static public IP addresses in use by Hosted Runners.", - "example": 17 - } - }, - "required": [ - "maximum", - "current_usage" - ] - } - }, - "required": [ - "public_ips" - ] - }, - "examples": { - "default": { - "value": { - "public_ips": { - "current_usage": 17, - "maximum": 50 - } + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "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", + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "total_count", - "machine_specs" - ], "properties": { - "total_count": { - "type": "integer" + "message": { + "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - } + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } - }, - "examples": { - "default": { - "value": { - "id": "4-core", - "cpu_cores": 4, - "memory_gb": 16, - "storage_gb": 150 + } + } + } + }, + "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": "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/enterprise-cloud@latest//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", + }, + "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", - "platforms" + "message", + "documentation_url" ], "properties": { - "total_count": { - "type": "integer" + "message": { + "type": "string" }, - "platforms": { + "documentation_url": { + "type": "string" + }, + "errors": { "type": "array", "items": { - "type": "string" + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "/organizations/{org}/dependabot/repository-access": { "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": "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": "actions/get-hosted-runner-for-org", + "operationId": "dependabot/repository-access-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/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" }, "parameters": [ { @@ -85927,12 +86571,26 @@ } }, { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, "schema": { - "type": "integer" + "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 } } ], @@ -85942,1250 +86600,47 @@ "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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": "hosted-runners" - } - }, - "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/hosted-runners#update-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" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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" - } - } - }, - "examples": { - "default": { - "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.", + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", "type": "object", "properties": { - "id": { - "description": "The unique identifier of the hosted runner.", - "type": "integer", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" - ], - "nullable": true - }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", + "default_level": { "type": "string", - "example": "Ready", + "description": "The default repository access level for Dependabot updates.", "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "hosted-runners" - } - }, - "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": [ - "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" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "hosted_runner_id", - "description": "Unique identifier of the GitHub-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "202": { - "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", - "example": 5 - }, - "name": { - "description": "The name of the hosted runner.", - "type": "string", - "example": "my-github-hosted-runner" - }, - "runner_group_id": { - "description": "The unique identifier of the group that the hosted runner belongs to.", - "type": "integer", - "example": 2 - }, - "image_details": { - "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", - "example": "ubuntu-20.04" - }, - "size_gb": { - "description": "Image size in GB.", - "type": "integer", - "example": 86 - }, - "display_name": { - "description": "Display name for this image.", - "type": "string", - "example": 20.04 - }, - "source": { - "description": "The image provider.", - "type": "string", - "enum": [ - "github", - "partner", - "custom" - ] - } - }, - "required": [ - "id", - "size_gb", - "display_name", - "source" + "public", + "internal" ], + "example": "internal", "nullable": true }, - "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", - "example": "8-core" - }, - "cpu_cores": { - "description": "The number of cores.", - "type": "integer", - "example": 8 - }, - "memory_gb": { - "description": "The available RAM for the machine spec.", - "type": "integer", - "example": 32 - }, - "storage_gb": { - "description": "The available SSD storage for the machine spec.", - "type": "integer", - "example": 300 - } - }, - "required": [ - "id", - "cpu_cores", - "memory_gb", - "storage_gb" - ] - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "Ready", - "enum": [ - "Ready", - "Provisioning", - "Shutdown", - "Deleting", - "Stuck" - ] - }, - "platform": { - "description": "The operating system of the image.", - "type": "string", - "example": "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, - "example": 5 - }, - "public_ip_enabled": { - "description": "Whether public IP is enabled for the hosted runners.", - "type": "boolean", - "example": 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", - "example": true - }, - "prefix": { - "description": "The prefix for the public IP.", - "type": "string", - "example": "20.80.208.150" - }, - "length": { - "description": "The length of the IP prefix.", - "type": "integer", - "example": 28 - } - } - } - }, - "last_active_on": { - "description": "The time at which the runner was last used, in ISO 8601 format.", - "type": "string", - "format": "date-time", - "example": "2022-10-09T23:39:01Z", - "nullable": true - } - }, - "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" - } - } - } - } - } - } - }, - "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", - "content": { - "application/json": { - "schema": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", - "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" - } - } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] - } - } - } - } - } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "oidc" - } - }, - "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.", - "tags": [ - "oidc" - ], - "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" - }, - "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": { - "title": "Actions OIDC Subject customization", - "description": "Actions OIDC Subject customization", - "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" - } - } - }, - "required": [ - "include_claim_keys" - ] - }, - "examples": { - "default": { - "value": { - "include_claim_keys": [ - "repo", - "context" - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Empty response", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "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": { - "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", - "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" - ] - }, - "selected_repositories_url": { - "type": "string", - "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." - }, - "allowed_actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] - }, - "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" - } - } - } - } - } - } - }, - "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": { - "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", - "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" - }, - "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", - "repositories" - ], - "properties": { - "total_count": { - "type": "number" - }, - "repositories": { + "accessible_repositories": { "type": "array", "items": { - "title": "Repository", - "description": "A repository on GitHub.", + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "example": 42, "type": "integer", - "format": "int64" + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." }, "name": { - "description": "The name of the repository.", "type": "string", - "example": "Team Environment" + "example": "Hello-World", + "description": "The name of the repository." }, "full_name": { "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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" - ] + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", @@ -87312,438 +86767,223 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true + "nullable": true, + "description": "The repository description." }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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" - } - } + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." } }, "required": [ @@ -87792,57 +87032,34 @@ "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" - ] + "url" + ], + "nullable": true } } - } + }, + "additionalProperties": false }, "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "default_level": "public", + "accessible_repositories": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", + "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://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", + "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", + "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}", @@ -87853,105 +87070,51 @@ "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 + "site_admin": false, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" }, "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", "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 + "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" } ] } @@ -87959,25 +87122,77 @@ } } } + }, + "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" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" } }, - "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", + "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-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" }, "parameters": [ { @@ -87990,11 +87205,6 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { "required": true, "content": { @@ -88002,25 +87212,49 @@ "schema": { "type": "object", "properties": { - "selected_repository_ids": { - "description": "List of repository IDs to enable for GitHub Actions.", + "repository_ids_to_add": { "type": "array", "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } + "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": [ - "selected_repository_ids" - ] + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } }, "examples": { - "default": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", "value": { - "selected_repository_ids": [ - 32, - 42 + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 ] } } @@ -88028,183 +87262,82 @@ } } }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/orgs/{org}/actions/permissions/repositories/{repository_id}": { - "put": { - "summary": "Enable a selected repository for GitHub Actions in an organization", - "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\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/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" } - }, - "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", + } + }, + "/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/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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", - "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": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] - } - } - } - } - } - } - }, - "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" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" }, "parameters": [ { @@ -88217,184 +87350,89 @@ } } ], - "responses": { - "204": { - "description": "Response" - } - }, "requestBody": { - "required": false, + "required": true, "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": { - "type": "string" - } + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal" } - } + }, + "required": [ + "default_level" + ] }, "examples": { - "selected_actions": { + "204": { + "summary": "Example with a 'succeeded' status.", "value": { - "github_owned_allowed": true, - "verified_allowed": false, - "patterns_allowed": [ - "monalisa/octocat@*", - "docker/*" - ] + "default_level": "public" } } } } } }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "permissions" - } - } - }, - "/orgs/{org}/actions/permissions/workflow": { - "get": { - "summary": "Get default workflow permissions for an organization", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-github-actions-default-workflow-permissions-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-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", + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] + "message": { + "type": "string" }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - }, - "required": [ - "default_workflow_permissions", - "can_approve_pull_request_reviews" - ] - }, - "examples": { - "default": { - "summary": "Give read-only permission, and allow approving PRs.", - "value": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" - } - }, - "put": { - "summary": "Set default workflow permissions for an organization", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/set-github-actions-default-workflow-permissions-organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-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": "Success response" }, - "409": { - "description": "Conflict response when changing a setting is prevented by the owning enterprise" - } - }, - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_workflow_permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] - }, - "can_approve_pull_request_reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - } - } - }, - "examples": { - "default": { - "summary": "Give read-only permission, and allow approving PRs.", - "value": { - "default_workflow_permissions": "read", - "can_approve_pull_request_reviews": true + "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" + } } } } @@ -88404,22 +87442,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "permissions" + "category": "dependabot", + "subcategory": "repository-access" } } }, - "/orgs/{org}/actions/runner-groups": { + "/organizations/{org}/settings/billing/usage": { "get": { - "summary": "List self-hosted runner groups for an organization", - "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-self-hosted-runner-groups-for-org", + "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/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" }, "parameters": [ { @@ -88432,116 +87470,111 @@ } }, { - "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).\"", + "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", - "default": 30 + "type": "integer" } }, { - "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).\"", + "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", - "default": 1 + "type": "integer" } }, { - "name": "visible_to_repository", - "description": "Only return runner groups that are allowed to be used by this repository.", + "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": "string" + "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": [ - "total_count", - "runner_groups" - ], "properties": { - "total_count": { - "type": "number" - }, - "runner_groups": { + "usageItems": { "type": "array", "items": { "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" + "date": { + "type": "string", + "description": "Date of the usage line item." }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "product": { + "type": "string", + "description": "Product name." }, - "runners_url": { - "type": "string" + "sku": { + "type": "string", + "description": "SKU name." }, - "hosted_runners_url": { - "type": "string" + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." }, - "inherited": { - "type": "boolean" + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." }, - "inherited_allows_public_repositories": { - "type": "boolean" + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." }, - "allows_public_repositories": { - "type": "boolean" + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false + "organizationName": { + "type": "string", + "description": "Name of the organization." }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "repositoryName": { + "type": "string", + "description": "Name of the repository." } }, "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" ] } } @@ -88550,48 +87583,19 @@ "examples": { "default": { "value": { - "total_count": 3, - "runner_groups": [ - { - "id": 1, - "name": "Default", - "visibility": "all", - "default": true, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [], - "workflow_restrictions_read_only": false - }, - { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "inherited": true, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": true - }, + "usageItems": [ { - "id": 3, - "name": "expensive-hardware", - "visibility": "private", - "default": false, - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": false, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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" } ] } @@ -88599,212 +87603,134 @@ } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - }, - "post": { - "summary": "Create a self-hosted runner group for an organization", - "description": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/create-self-hosted-runner-group-for-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-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 group.", - "type": "string" - }, - "visibility": { - "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", - "type": "string", - "enum": [ - "selected", - "all", - "private" - ], - "default": "all" - }, - "selected_repository_ids": { - "description": "List of repository IDs that can access the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } - }, - "runners": { - "description": "List of runner IDs to add to the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." - } - }, - "allows_public_repositories": { - "description": "Whether the runner group can be used by `public` repositories.", - "type": "boolean", - "default": false - }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false - }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + }, + "400": { + "description": "Bad Request", + "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" } - }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" } - }, - "required": [ - "name" - ] + } }, - "examples": { - "default": { - "value": { - "name": "Expensive hardware runners", - "visibility": "selected", - "selected_repository_ids": [ - 32, - 91 - ], - "runners": [ - 9, - 2 - ] + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } } } } } - } - }, - "responses": { - "201": { - "description": "Response", + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { + "message": { "type": "string" }, - "visibility": { + "documentation_url": { "type": "string" }, - "default": { - "type": "boolean" - }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "url": { "type": "string" }, - "runners_url": { + "status": { "type": "string" - }, - "hosted_runners_url": { + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { "type": "string" }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", + "documentation_url": { "type": "string" }, - "inherited": { - "type": "boolean" - }, - "inherited_allows_public_repositories": { - "type": "boolean" - }, - "allows_public_repositories": { - "type": "boolean" + "url": { + "type": "string" }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", - "type": "boolean", - "default": false + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false + "message": { + "type": "string" }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } - } - }, - "required": [ - "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" - ] - }, - "examples": { - "default": { - "value": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "documentation_url": { + "type": "string" } } } @@ -88813,24 +87739,24 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "/orgs/{org}": { "get": { - "summary": "Get a self-hosted runner group for an organization", - "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/get-self-hosted-runner-group-for-org", + "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/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -88841,15 +87767,6 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { @@ -88858,91 +87775,472 @@ "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", + "example": "github" + }, "id": { - "type": "number" + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, "name": { - "type": "string" + "type": "string", + "example": "github" }, - "visibility": { - "type": "string" + "company": { + "type": "string", + "example": "GitHub" }, - "default": { - "type": "boolean" + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "location": { + "type": "string", + "example": "San Francisco" }, - "runners_url": { - "type": "string" + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" }, - "hosted_runners_url": { - "type": "string" + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "is_verified": { + "type": "boolean", + "example": true }, - "inherited": { - "type": "boolean" + "has_organization_projects": { + "type": "boolean", + "example": true }, - "inherited_allows_public_repositories": { - "type": "boolean" + "has_repository_projects": { + "type": "boolean", + "example": true }, - "allows_public_repositories": { - "type": "boolean" + "public_repos": { + "type": "integer", + "example": 2 }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "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", + "nullable": true + }, + "default_repository_branch": { + "type": "string", + "example": "main", + "nullable": true, + "description": "The default branch for repositories created in this organization." + }, + "members_can_create_repositories": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "two_factor_requirement_enabled": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_delete_repositories": { + "type": "boolean", + "example": true + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "example": true + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "example": true + }, + "members_can_delete_issues": { + "type": "boolean", + "example": true + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "example": true + }, + "readers_can_create_discussions": { + "type": "boolean", + "example": true + }, + "members_can_create_teams": { + "type": "boolean", + "example": true + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "example": false, + "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", + "example": "https://github.com/test-org/test-repo/blob/main/README.md", + "nullable": true, + "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + }, + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "example": false, + "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 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ + "login", + "url", "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "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": { + "default-response": { "value": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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" } } } @@ -88951,22 +88249,22 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" } }, "patch": { - "summary": "Update a self-hosted runner group for an organization", - "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/update-self-hosted-runner-group-for-org", + "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": [ - "actions" + "orgs" ], + "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -88977,71 +88275,179 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { - "required": true, + "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": { - "description": "Name of the runner group.", - "type": "string" + "type": "string", + "description": "The shorthand name of the company." }, - "visibility": { - "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", + "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": [ - "selected", "all", - "private" + "private", + "none" ] }, - "allows_public_repositories": { - "description": "Whether the runner group can be used by `public` repositories.", + "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 }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "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 }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "blog": { + "type": "string", + "example": "\"http://github.blog\"" }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", + "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", - "nullable": true + "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": [ - "name" - ] + } }, "examples": { "default": { "value": { - "name": "Expensive hardware runners", - "visibility": "selected" + "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" } } } @@ -89054,160 +88460,765 @@ "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", + "example": "github" + }, "id": { - "type": "number" + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, "name": { - "type": "string" + "type": "string", + "example": "github" }, - "visibility": { - "type": "string" + "company": { + "type": "string", + "example": "GitHub" }, - "default": { - "type": "boolean" + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" }, - "selected_repositories_url": { - "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", - "type": "string" + "location": { + "type": "string", + "example": "San Francisco" }, - "runners_url": { - "type": "string" + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" }, - "hosted_runners_url": { - "type": "string" + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true }, - "network_configuration_id": { - "description": "The identifier of a hosted compute network configuration.", - "type": "string" + "is_verified": { + "type": "boolean", + "example": true }, - "inherited": { - "type": "boolean" + "has_organization_projects": { + "type": "boolean", + "example": true }, - "inherited_allows_public_repositories": { - "type": "boolean" + "has_repository_projects": { + "type": "boolean", + "example": true }, - "allows_public_repositories": { - "type": "boolean" + "public_repos": { + "type": "integer", + "example": 2 }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "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", + "nullable": true + }, + "default_repository_branch": { + "type": "string", + "example": "main", + "nullable": true, + "description": "The default branch for repositories created in this organization." + }, + "members_can_create_repositories": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "two_factor_requirement_enabled": { "type": "boolean", - "default": false + "example": true, + "nullable": true }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", - "type": "array", - "items": { - "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_delete_repositories": { + "type": "boolean", + "example": true + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "example": true + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "example": true + }, + "members_can_delete_issues": { + "type": "boolean", + "example": true + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "example": true + }, + "readers_can_create_discussions": { + "type": "boolean", + "example": true + }, + "members_can_create_teams": { + "type": "boolean", + "example": true + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "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.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "example": false, + "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", + "example": "https://github.com/test-org/test-repo/blob/main/README.md", + "nullable": true, + "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + }, + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "example": false, + "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 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ + "login", + "url", "id", - "name", - "visibility", - "default", - "runners_url", - "inherited", - "allows_public_repositories" + "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": { - "id": 2, - "name": "octo-runner-group", - "visibility": "selected", - "default": false, - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", - "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", - "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", - "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", - "inherited": false, - "allows_public_repositories": true, - "restricted_to_workflows": true, - "selected_workflows": [ - "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" - ], - "workflow_restrictions_read_only": false + "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 } } } } } - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - }, - "delete": { - "summary": "Delete a self-hosted runner group from an organization", - "description": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/delete-self-hosted-runner-group-from-org", - "tags": [ - "actions" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "enabledForGitHubApps": true, - "githubCloudOnly": false, - "category": "actions", - "subcategory": "self-hosted-runner-groups" - } - } - }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": "List GitHub-hosted runners in a group for an organization", - "description": "Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-github-hosted-runners-in-group-for-org", + "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/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + "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": [ { @@ -89220,12 +89231,130 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", + "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", + "example": "octo-org/Hello-World" + }, + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", + "example": 2322142 + }, + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", + "example": 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": "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": "integer" + "type": "string" } }, { @@ -89260,7 +89389,7 @@ ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, "runners": { "type": "array", @@ -89500,24 +89629,22 @@ } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - } - }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { - "get": { - "summary": "List repository access to a self-hosted runner group in an organization", - "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + }, + "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/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -89528,994 +89655,276 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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 - } - }, - { - "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 - } } ], + "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": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "number" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 }, - "repositories": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true }, - "role_name": { + "prefix": { + "description": "The prefix for the public IP.", "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 + "example": "20.80.208.150" }, - "watchers": { + "length": { + "description": "The length of the IP prefix.", "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "example": 28 } - }, - "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" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true } - } + }, + "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 - }, - "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 - }, - "template_repository": { - "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", - "organization": null, - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "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 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": 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==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 } - ] + ], + "last_active_on": "2022-10-09T23:39:01Z" } } } @@ -90527,19 +89936,21 @@ "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "put": { - "summary": "Set repository access for a self-hosted runner group in an organization", - "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", + } + }, + "/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/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -90550,74 +89961,105 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "description": "List of repository IDs that can access the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." + "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", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + } } } }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 32, - 91 - ] + "examples": { + "default": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { - "put": { - "summary": "Add repository access to a self-hosted runner group in an organization", - "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "/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/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -90628,48 +90070,105 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "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", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 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" + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "delete": { - "summary": "Remove repository access to a self-hosted runner group in an organization", - "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", + } + }, + "/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/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-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": [ { @@ -90680,50 +90179,75 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Response" + "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.", + "example": 50 + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "example": 17 + } + }, + "required": [ + "maximum", + "current_usage" + ] + } + }, + "required": [ + "public_ips" + ] + }, + "examples": { + "default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } + } + } + } + } + } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "/orgs/{org}/actions/hosted-runners/machine-sizes": { "get": { - "summary": "List self-hosted runners in a group for an organization", - "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "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/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" }, "parameters": [ { @@ -90734,33 +90258,6 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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": { @@ -90772,87 +90269,45 @@ "type": "object", "required": [ "total_count", - "runners" + "machine_specs" ], "properties": { "total_count": { - "type": "number" + "type": "integer" }, - "runners": { + "machine_specs": { "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", "type": "object", "properties": { "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "example": "8-core" }, - "runner_group_id": { - "description": "The ID of the runner group.", + "cpu_cores": { + "description": "The number of cores.", "type": "integer", - "example": 1 + "example": 8 }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 } }, "required": [ "id", - "name", - "os", - "status", - "busy", - "labels" + "cpu_cores", + "memory_gb", + "storage_gb" ] } } @@ -90861,96 +90316,36 @@ "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] - }, - { - "id": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - ] + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - }, - "put": { - "summary": "Set self-hosted runners in a group for an organization", - "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/set-self-hosted-runners-in-group-for-org", + } + }, + "/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/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" }, "parameters": [ { @@ -90961,74 +90356,65 @@ "schema": { "type": "string" } - }, - { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "runners": { - "description": "List of runner IDs to add to the runner group.", - "type": "array", - "items": { - "type": "integer", - "description": "Unique identifier of the runner." + "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" + } } } }, - "required": [ - "runners" - ] - }, - "examples": { - "default": { - "value": { - "runners": [ - 9, - 2 - ] + "examples": { + "default": { + "value": { + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] + } } } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { - "put": { - "summary": "Add a self-hosted runner to a group for an organization", - "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/add-self-hosted-runner-to-group-for-org", + "/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/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -91041,17 +90427,8 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -91060,27 +90437,233 @@ } ], "responses": { - "204": { - "description": "Response" + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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": { - "enabledForGitHubApps": true, "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } }, - "delete": { - "summary": "Remove a self-hosted runner from a group for an organization", - "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "operationId": "actions/remove-self-hosted-runner-from-group-for-org", + "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/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" }, "parameters": [ { @@ -91093,17 +90676,8 @@ } }, { - "name": "runner_group_id", - "description": "Unique identifier of the self-hosted runner group.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", "in": "path", "required": true, "schema": { @@ -91111,40 +90685,266 @@ } } ], + "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" + } + } + }, + "examples": { + "default": { + "value": { + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false + } + } + } + } + } + }, "responses": { - "204": { - "description": "Response" + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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" + } + } + } + } + } } }, "x-github": { "enabledForGitHubApps": true, "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runner-groups" + "subcategory": "hosted-runners" } - } - }, - "/orgs/{org}/actions/runners": { - "get": { - "summary": "List self-hosted runners for an organization", - "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + }, + "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": [ "actions" ], - "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" }, "parameters": [ - { - "name": "name", - "description": "The name of a self-hosted runner.", - "in": "query", - "schema": { - "type": "string" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -91155,214 +90955,237 @@ } }, { - "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", + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], "responses": { - "200": { + "202": { "description": "Response", "content": { "application/json": { "schema": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", "type": "object", - "required": [ - "total_count", - "runners" - ], "properties": { - "total_count": { - "type": "integer" + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 }, - "runners": { + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", "type": "array", "items": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", "type": "object", "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true }, - "status": { - "description": "The status of the runner.", + "prefix": { + "description": "The prefix for the public IP.", "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } + "example": "20.80.208.150" }, - "ephemeral": { - "type": "boolean" + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] + } } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true } - } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] }, "examples": { "default": { "value": { - "total_count": 2, - "runners": [ - { - "id": 23, - "name": "linux_runner", - "os": "linux", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 11, - "name": "Linux", - "type": "read-only" - } - ] - }, + "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": 24, - "name": "mac_runner", - "os": "macos", - "status": "offline", - "busy": false, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] + "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, + "enabledForGitHubApps": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "hosted-runners" } } }, - "/orgs/{org}/actions/runners/downloads": { + "/orgs/{org}/actions/oidc/customization/sub": { "get": { - "summary": "List runner applications for an organization", - "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "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": [ - "actions" + "oidc" ], - "operationId": "actions/list-runner-applications-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/actions/self-hosted-runners#list-runner-applications-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": [ { @@ -91377,78 +91200,34 @@ ], "responses": { "200": { - "description": "Response", + "description": "A JSON serialized template for OIDC subject claim customization", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Runner Application", - "description": "Runner Application", - "type": "object", - "properties": { - "os": { - "type": "string" - }, - "architecture": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "filename": { - "type": "string" - }, - "temp_download_token": { - "description": "A short lived bearer token used to download the runner, if needed.", - "type": "string" - }, - "sha256_checksum": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", + "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" } - }, - "required": [ - "os", - "architecture", - "download_url", - "filename" - ] - } + } + }, + "required": [ + "include_claim_keys" + ] }, "examples": { "default": { - "value": [ - { - "os": "osx", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", - "filename": "actions-runner-osx-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", - "filename": "actions-runner-linux-x64-2.164.0.tar.gz" - }, - { - "os": "linux", - "architecture": "arm", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm-2.164.0.tar.gz" - }, - { - "os": "win", - "architecture": "x64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", - "filename": "actions-runner-win-x64-2.164.0.zip" - }, - { - "os": "linux", - "architecture": "arm64", - "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", - "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" - } - ] + "value": { + "include_claim_keys": [ + "repo", + "context" + ] + } } } } @@ -91456,24 +91235,21 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "oidc" } - } - }, - "/orgs/{org}/actions/runners/generate-jitconfig": { - "post": { - "summary": "Create configuration for a just-in-time runner for an organization", - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + }, + "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.", "tags": [ - "actions" + "oidc" ], - "operationId": "actions/generate-runner-jitconfig-for-org", + "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -91491,49 +91267,29 @@ "content": { "application/json": { "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", "type": "object", - "required": [ - "name", - "runner_group_id", - "labels" - ], "properties": { - "name": { - "type": "string", - "description": "The name of the new runner." - }, - "runner_group_id": { - "type": "integer", - "description": "The ID of the runner group to register the runner to." - }, - "labels": { + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", "type": "array", - "minItems": 1, - "maxItems": 100, "items": { "type": "string" - }, - "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." - }, - "work_folder": { - "type": "string", - "description": "The working directory to be used for job execution, relative to the runner install directory.", - "default": "_work" + } } - } + }, + "required": [ + "include_claim_keys" + ] }, "examples": { "default": { "value": { - "name": "New runner", - "runner_group_id": 1, - "labels": [ - "self-hosted", - "X64", - "macOS", - "no-gpu" - ], - "work_folder": "_work" + "include_claim_keys": [ + "repo", + "context" + ] } } } @@ -91542,131 +91298,19 @@ }, "responses": { "201": { - "description": "Response", + "description": "Empty response", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "required": [ - "runner", - "encoded_jit_config" - ], - "properties": { - "runner": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] - }, - "encoded_jit_config": { - "type": "string", - "description": "The base64 encoded runner configuration." - } - } + "properties": {}, + "additionalProperties": false }, "examples": { "default": { - "value": { - "runner": { - "id": 23, - "name": "New runner", - "os": "unknown", - "status": "offline", - "busy": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - }, - "encoded_jit_config": "abc123" - } + "value": null } } } @@ -91698,18 +91342,14 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -91717,37 +91357,94 @@ "documentation_url": { "type": "string" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - }, - "409": { - "description": "Conflict", + } + }, + "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", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" + "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" + ] }, - "documentation_url": { - "type": "string" + "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`." }, - "url": { - "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" + ] }, - "status": { - "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" } } } @@ -91756,24 +91453,99 @@ } }, "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": "self-hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runners/registration-token": { - "post": { - "summary": "Create a registration token for an organization", - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/orgs/{org}/actions/permissions/repositories": { + "get": { + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\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" ], - "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -91784,38 +91556,42 @@ "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": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", + "required": [ + "total_count", + "repositories" + ], "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "example": "v1.1f699f1069f60xxx" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "example": "2016-07-11T22:14:10Z" - }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - } + "total_count": { + "type": "number" }, "repositories": { - "description": "The repositories this token has access to", "type": "array", "items": { "title": "Repository", @@ -92546,57 +92322,319 @@ "updated_at" ] } - }, - "single_file": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] } - }, - "required": [ - "token", - "expires_at" - ] + } }, "examples": { "default": { "value": { - "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-22T12:13:35.123-08:00" + "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 + } + ] + } + } + } + } + } + } + }, + "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", + "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" + }, + "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": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." } } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] + } } } } } }, "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\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/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "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", + "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" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "permissions" } } }, - "/orgs/{org}/actions/runners/remove-token": { - "post": { - "summary": "Create a remove token for an organization", - "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/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" ], - "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -92610,139 +92648,1463 @@ } ], "responses": { - "201": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Authentication Token", - "description": "Authentication Token", "type": "object", "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "example": "v1.1f699f1069f60xxx" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "example": "2016-07-11T22:14:10Z" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - } + "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." }, - "repositories": { - "description": "The repositories this token has access to", + "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": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "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": { + "type": "string" + } + } + } + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/workflow": { + "get": { + "summary": "Get default workflow permissions for an organization", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-github-actions-default-workflow-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-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": { + "default_workflow_permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] + }, + "can_approve_pull_request_reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + } + }, + "required": [ + "default_workflow_permissions", + "can_approve_pull_request_reviews" + ] + }, + "examples": { + "default": { + "summary": "Give read-only permission, and allow approving PRs.", + "value": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set default workflow permissions for an organization", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-github-actions-default-workflow-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-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": "Success response" + }, + "409": { + "description": "Conflict response when changing a setting is prevented by the owning enterprise" + } + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_workflow_permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] + }, + "can_approve_pull_request_reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + } + } + }, + "examples": { + "default": { + "summary": "Give read-only permission, and allow approving PRs.", + "value": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an organization", + "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runner-groups-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-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 + } + }, + { + "name": "visible_to_repository", + "description": "Only return runner groups that are allowed to be used by this repository.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runner_groups" + ], + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [], + "workflow_restrictions_read_only": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": true, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "post": { + "summary": "Create a self-hosted runner group for an organization", + "description": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-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 group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an organization", + "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "patch": { + "summary": "Update a self-hosted runner group for an organization", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ] + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an organization", + "description": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + "get": { + "summary": "List GitHub-hosted runners in a group for an organization", + "description": "Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-github-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": "number" + }, + "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", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "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", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "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", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "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, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": 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", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + } + }, + "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 + }, + "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" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + "get": { + "summary": "List repository access to a self-hosted runner group in an organization", + "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, "email": { "nullable": true, "type": "string" @@ -92859,8 +94221,6 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -92955,8 +94315,7 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "type": "string" }, "issue_comment_url": { "type": "string", @@ -93005,8 +94364,7 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "type": "string" }, "stargazers_url": { "type": "string", @@ -93042,13 +94400,10 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "type": "string" }, "mirror_url": { "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -93057,14 +94412,10 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "type": "string" }, "homepage": { "type": "string", - "format": "uri", - "example": "https://github.com", "nullable": true }, "language": { @@ -93072,36 +94423,26 @@ "nullable": true }, "forks_count": { - "type": "integer", - "example": 9 + "type": "integer" }, "stargazers_count": { - "type": "integer", - "example": 80 + "type": "integer" }, "watchers_count": { - "type": "integer", - "example": 80 + "type": "integer" }, "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", - "example": 108 + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" + "type": "string" }, "open_issues_count": { - "type": "integer", - "example": 0 + "type": "integer" }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true + "type": "boolean" }, "topics": { "type": "array", @@ -93110,51 +94451,30 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true + "type": "boolean" }, "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true + "type": "boolean" }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "type": "boolean" }, "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", "type": "string" }, "pushed_at": { @@ -93175,122 +94495,226 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" }, "temp_clone_token": { "type": "string" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false + "type": "boolean" }, - "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", - "example": false + "subscribers_count": { + "type": "integer" }, - "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 + "network_count": { + "type": "integer" }, - "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)." + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] }, - "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." + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true }, - "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)." + "forks": { + "type": "integer", + "example": 0 }, - "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." + "open_issues": { + "type": "integer", + "example": 0 }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true + "watchers": { + "type": "integer", + "example": 0 }, "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", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "example": false }, - "code_search_index_status": { + "security_and_analysis": { + "nullable": true, "type": "object", - "description": "The status of the code search index for this repository", "properties": { - "lexical_search_ok": { - "type": "boolean" + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } }, - "lexical_commit_sha": { - "type": "string" + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -93339,292 +94763,259 @@ "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" + "url" ] } - }, - "single_file": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - } - }, - "required": [ - "token", - "expires_at" - ] - }, - "examples": { - "default": { - "value": { - "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", - "expires_at": "2020-01-29T12:13:35.123-08:00" } } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - } - }, - "/orgs/{org}/actions/runners/{runner_id}": { - "get": { - "summary": "Get a self-hosted runner for an organization", - "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/get-self-hosted-runner-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-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" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Self hosted runners", - "description": "A self hosted runner", - "type": "object", - "properties": { - "id": { - "description": "The ID of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The ID of the runner group.", - "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" - }, - "os": { - "description": "The Operating System of the runner.", - "type": "string", - "example": "macos" - }, - "status": { - "description": "The status of the runner.", - "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - }, - "ephemeral": { - "type": "boolean" - } - }, - "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" - ] }, "examples": { "default": { "value": { - "id": 23, - "name": "MBP", - "os": "macos", - "status": "online", - "busy": true, - "ephemeral": false, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, + "total_count": 1, + "repositories": [ { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "self-hosted-runners" - } - }, - "delete": { - "summary": "Delete a self-hosted runner from an organization", - "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-self-hosted-runner-from-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "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" - } + "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 + }, + "template_repository": { + "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", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "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 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": 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==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] } } } @@ -93633,24 +95024,22 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - } - }, - "/orgs/{org}/actions/runners/{runner_id}/labels": { - "get": { - "summary": "List labels for a self-hosted runner for an organization", - "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + }, + "put": { + "summary": "Set repository access for a self-hosted runner group in an organization", + "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], - "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -93663,8 +95052,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -93672,128 +95061,115 @@ } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." } } }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 91 + ] } } } } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + "put": { + "summary": "Add repository access to a self-hosted runner group in an organization", + "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "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" - } - } - } - } + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } + ], + "responses": { + "204": { + "description": "Response" + } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } }, - "post": { - "summary": "Add custom labels to a self-hosted runner for an organization", - "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "delete": { + "summary": "Remove repository access to a self-hosted runner group in an organization", + "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", "tags": [ "actions" ], - "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -93806,8 +95182,17 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "path", "required": true, "schema": { @@ -93815,40 +95200,69 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "labels" - ], - "properties": { - "labels": { - "type": "array", - "minItems": 1, - "maxItems": 100, - "description": "The names of the custom labels to add to the runner.", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "labels": [ - "gpu", - "accelerated" - ] - } - } - } - } + "responses": { + "204": { + "description": "Response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an organization", + "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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", @@ -93858,38 +95272,87 @@ "type": "object", "required": [ "total_count", - "labels" + "runners" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "labels": { + "runners": { "type": "array", "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { "id": { + "description": "The ID of the runner.", "type": "integer", - "description": "Unique identifier of the label." + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 }, "name": { + "description": "The name of the runner.", "type": "string", - "description": "Name of the label." + "example": "iMac" }, - "type": { + "os": { + "description": "The Operating System of the runner.", "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } }, "required": [ - "name" + "id", + "name", + "os", + "status", + "busy", + "labels" ] } } @@ -93898,109 +95361,96 @@ "examples": { "default": { "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, + "total_count": 2, + "runners": [ { - "id": 20, - "name": "macOS", - "type": "read-only" + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] }, { - "id": 21, - "name": "no-gpu", - "type": "custom" + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } ] } } } } - } - }, - "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": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "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" - } - } - } + "type": "string" } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } }, "put": { - "summary": "Set custom labels for a self-hosted runner for an organization", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "Set self-hosted runners in a group for an organization", + "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-in-group-for-org", "tags": [ "actions" ], - "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -94013,8 +95463,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -94028,27 +95478,26 @@ "application/json": { "schema": { "type": "object", - "required": [ - "labels" - ], "properties": { - "labels": { + "runners": { + "description": "List of runner IDs to add to the runner group.", "type": "array", - "minItems": 0, - "maxItems": 100, - "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", "items": { - "type": "string" + "type": "integer", + "description": "Unique identifier of the runner." } } - } + }, + "required": [ + "runners" + ] }, "examples": { "default": { "value": { - "labels": [ - "gpu", - "accelerated" + "runners": [ + 9, + 2 ] } } @@ -94057,157 +95506,29 @@ } }, "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - }, - "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 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" - } - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - }, - "delete": { - "summary": "Remove all custom labels from a self-hosted runner for an organization", - "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an organization", + "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-self-hosted-runner-to-group-for-org", "tags": [ "actions" ], - "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" }, "parameters": [ { @@ -94219,6 +95540,15 @@ "type": "string" } }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", @@ -94230,124 +95560,27 @@ } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 3, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - } - ] - } - } - } - } - } - }, - "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" - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } - } - }, - "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + }, "delete": { - "summary": "Remove a custom label from a self-hosted runner for an organization", - "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "Remove a self-hosted runner from a group for an organization", + "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-self-hosted-runner-from-group-for-org", "tags": [ "actions" ], - "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" }, "parameters": [ { @@ -94360,8 +95593,8 @@ } }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -94369,171 +95602,49 @@ } }, { - "name": "name", - "description": "The name of a self-hosted runner's custom label.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "labels" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "labels": { - "type": "array", - "items": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { - "type": "string", - "description": "Name of the label." - }, - "type": { - "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] - } - }, - "required": [ - "name" - ] - } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 4, - "labels": [ - { - "id": 5, - "name": "self-hosted", - "type": "read-only" - }, - { - "id": 7, - "name": "X64", - "type": "read-only" - }, - { - "id": 20, - "name": "macOS", - "type": "read-only" - }, - { - "id": 21, - "name": "no-gpu", - "type": "custom" - } - ] - } - } - } - } - } - }, - "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 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" - } - } - } - } - } - } + "204": { + "description": "Response" } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "category": "actions", - "subcategory": "self-hosted-runners" + "subcategory": "self-hosted-runner-groups" } } }, - "/orgs/{org}/actions/secrets": { + "/orgs/{org}/actions/runners": { "get": { - "summary": "List organization secrets", - "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "List self-hosted runners for an organization", + "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/list-org-secrets", + "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" }, "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -94571,52 +95682,87 @@ "type": "object", "required": [ "total_count", - "secrets" + "runners" ], "properties": { "total_count": { "type": "integer" }, - "secrets": { + "runners": { "type": "array", "items": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" + "description": "The name of the runner.", + "type": "string", + "example": "iMac" }, - "created_at": { + "os": { + "description": "The Operating System of the runner.", "type": "string", - "format": "date-time" + "example": "macos" }, - "updated_at": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "date-time" + "example": "online" }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" + "busy": { + "type": "boolean" }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } }, "required": [ + "id", "name", - "created_at", - "updated_at", - "visibility" + "os", + "status", + "busy", + "labels" ] } } @@ -94625,26 +95771,62 @@ "examples": { "default": { "value": { - "total_count": 3, - "secrets": [ - { - "name": "GIST_ID", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, + "total_count": 2, + "runners": [ { - "name": "DEPLOY_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] }, { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } ] } @@ -94666,21 +95848,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/public-key": { + "/orgs/{org}/actions/runners/downloads": { "get": { - "summary": "Get an organization public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "summary": "List runner applications for an organization", + "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/get-org-public-key", + "operationId": "actions/list-runner-applications-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" }, "parameters": [ { @@ -94699,48 +95881,74 @@ "content": { "application/json": { "schema": { - "title": "ActionsPublicKey", - "description": "The public key used for setting Actions Secrets.", - "type": "object", - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "example": "1234567" - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - }, - "id": { - "type": "integer", - "example": 2 - }, - "url": { - "type": "string", - "example": "https://api.github.com/user/keys/2" - }, - "title": { - "type": "string", - "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + "type": "array", + "items": { + "title": "Runner Application", + "description": "Runner Application", + "type": "object", + "properties": { + "os": { + "type": "string" + }, + "architecture": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "temp_download_token": { + "description": "A short lived bearer token used to download the runner, if needed.", + "type": "string" + }, + "sha256_checksum": { + "type": "string" + } }, - "created_at": { - "type": "string", - "example": "2011-01-26T19:01:12Z" - } - }, - "required": [ - "key_id", - "key" - ] + "required": [ + "os", + "architecture", + "download_url", + "filename" + ] + } }, "examples": { "default": { - "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - } + "value": [ + { + "os": "osx", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", + "filename": "actions-runner-osx-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", + "filename": "actions-runner-linux-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "arm", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm-2.164.0.tar.gz" + }, + { + "os": "win", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", + "filename": "actions-runner-win-x64-2.164.0.zip" + }, + { + "os": "linux", + "architecture": "arm64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" + } + ] } } } @@ -94751,119 +95959,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Actions Secret for an Organization", - "description": "Secrets for GitHub Actions for an organization.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "example": "SECRET_TOKEN", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a secret", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "/orgs/{org}/actions/runners/generate-jitconfig": { + "post": { + "summary": "Create configuration for a just-in-time runner for an organization", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/create-or-update-org-secret", + "operationId": "actions/generate-runner-jitconfig-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" }, "parameters": [ { @@ -94874,15 +95984,6 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -94891,49 +95992,48 @@ "application/json": { "schema": { "type": "object", + "required": [ + "name", + "runner_group_id", + "labels" + ], "properties": { - "encrypted_value": { - "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { + "name": { "type": "string", - "description": "ID of the key you used to encrypt the secret." + "description": "The name of the new runner." }, - "visibility": { - "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "enum": [ - "all", - "private", - "selected" - ] + "runner_group_id": { + "type": "integer", + "description": "The ID of the runner group to register the runner to." }, - "selected_repository_ids": { + "labels": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "minItems": 1, + "maxItems": 100, "items": { - "type": "integer" - } + "type": "string" + }, + "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." + }, + "work_folder": { + "type": "string", + "description": "The working directory to be used for job execution, relative to the runner install directory.", + "default": "_work" } - }, - "required": [ - "encrypted_value", - "key_id", - "visibility" - ] + } }, "examples": { "default": { "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" } } } @@ -94942,90 +96042,238 @@ }, "responses": { "201": { - "description": "Response when creating a secret", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", "type": "object", - "properties": {}, - "additionalProperties": false + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } }, "examples": { "default": { - "value": null + "value": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + } } } } } }, - "204": { - "description": "Response when updating a secret" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "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" + } + } + } + } } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } } - } - ], - "responses": { - "204": { - "description": "Response" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "secrets" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/secrets/{secret_name}/repositories": { - "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "/orgs/{org}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for an organization", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/list-selected-repos-for-org-secret", + "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" }, "parameters": [ { @@ -95036,74 +96284,133 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 - } } ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } }, "repositories": { + "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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.", @@ -95229,6 +96536,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -95323,7 +96632,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string" + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", @@ -95372,7 +96682,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string" + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", @@ -95408,10 +96719,13 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string" + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -95420,10 +96734,14 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", + "format": "uri", + "example": "https://github.com", "nullable": true }, "language": { @@ -95431,26 +96749,36 @@ "nullable": true }, "forks_count": { - "type": "integer" + "type": "integer", + "example": 9 }, "stargazers_count": { - "type": "integer" + "type": "integer", + "example": 80 }, "watchers_count": { - "type": "integer" + "type": "integer", + "example": 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" + "type": "integer", + "example": 108 }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "example": "master" }, "open_issues_count": { - "type": "integer" + "type": "integer", + "example": 0 }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true }, "topics": { "type": "array", @@ -95459,30 +96787,51 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -95503,226 +96852,122 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, "delete_branch_on_merge": { - "type": "boolean" + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "subscribers_count": { - "type": "integer" + "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", + "example": false }, - "network_count": { - "type": "integer" + "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 }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] + "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)." }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true + "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." }, - "forks": { - "type": "integer", - "example": 0 + "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)." }, - "open_issues": { - "type": "integer", - "example": 0 + "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." }, - "watchers": { - "type": "integer", - "example": 0 + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": 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", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { "type": "boolean", - "example": false + "description": "Whether anonymous git access is enabled for this repository" }, - "security_and_analysis": { - "nullable": true, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_search_ok": { + "type": "boolean" }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_commit_sha": { + "type": "string" } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ @@ -95771,809 +97016,87 @@ "tags_url", "teams_url", "trees_url", - "url" - ] - } - } - } - }, - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/set-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "integer" - } - } - }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/add-selected-repo-to-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "No Content when repository was added to the selected list" - }, - "409": { - "description": "Conflict when visibility type is not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - }, - "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/remove-selected-repo-from-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response when repository was removed from the selected list" - }, - "409": { - "description": "Conflict when visibility type not set to selected" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "secrets" - } - } - }, - "/orgs/{org}/actions/variables": { - "get": { - "summary": "List organization variables", - "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/list-org-variables", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables" - }, - "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 30). 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": 10 - } - }, - { - "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", - "variables" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "variables": { - "type": "array", - "items": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "example": "USERNAME", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "example": "octocat", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a variable", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" - } - }, - "required": [ - "name", - "value", + "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", - "visibility" + "updated_at" ] } - } - } - }, - "examples": { - "default": { - "value": { - "total_count": 3, - "variables": [ - { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "private" - }, - { - "name": "ACTIONS_RUNNER_DEBUG", - "value": true, - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "ADMIN_EMAIL", - "value": "octocat@github.com", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "post": { - "summary": "Create an organization variable", - "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/create-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable" - }, - "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": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - }, - "visibility": { - "type": "string", - "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", - "items": { - "type": "integer" - } - } - }, - "required": [ - "name", - "value", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response when creating a variable", - "content": { - "application/json": { - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - } - }, - "/orgs/{org}/actions/variables/{name}": { - "get": { - "summary": "Get an organization variable", - "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/get-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Actions Variable for an Organization", - "description": "Organization variable for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the variable.", - "example": "USERNAME", - "type": "string" - }, - "value": { - "description": "The value of the variable.", - "example": "octocat", - "type": "string" }, - "created_at": { - "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", + "single_file": { "type": "string", - "format": "date-time" + "example": "config.yaml", + "nullable": true }, - "updated_at": { - "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "example": "2019-01-24T22:45:36.000Z", + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "Visibility of a variable", "enum": [ "all", - "private", "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" + ] } }, "required": [ - "name", - "value", - "created_at", - "updated_at", - "visibility" + "token", + "expires_at" ] }, "examples": { "default": { "value": { - "name": "USERNAME", - "value": "octocat", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "selected", - "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "patch": { - "summary": "Update an organization variable", - "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", - "tags": [ - "actions" - ], - "operationId": "actions/update-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the variable." - }, - "value": { - "type": "string", - "description": "The value of the variable." - }, - "visibility": { - "type": "string", - "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", - "enum": [ - "all", - "private", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", - "items": { - "type": "integer" + "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-22T12:13:35.123-08:00" } } } - }, - "examples": { - "default": { - "value": { - "name": "USERNAME", - "value": "octocat", - "visibility": "selected", - "selected_repository_ids": [ - 1296269, - 1296280 - ] - } - } } } } }, - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - }, - "delete": { - "summary": "Delete an organization variable", - "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", - "tags": [ - "actions" - ], - "operationId": "actions/delete-org-variable", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/actions/variables/{name}/repositories": { - "get": { - "summary": "List selected repositories for an organization variable", - "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "/orgs/{org}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for an organization", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/list-selected-repos-for-org-variable", + "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" }, "parameters": [ { @@ -96584,74 +97107,133 @@ "schema": { "type": "string" } - }, - { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "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 - } - }, - { - "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 - } } ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "required": [ - "total_count", - "repositories" - ], "properties": { - "total_count": { - "type": "integer" + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } }, "repositories": { + "description": "The repositories this token has access to", "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "format": "int64", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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.", @@ -96777,6 +97359,8 @@ ] }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -96871,7 +97455,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string" + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, "issue_comment_url": { "type": "string", @@ -96920,7 +97505,8 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string" + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, "stargazers_url": { "type": "string", @@ -96956,10 +97542,13 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string" + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, "mirror_url": { "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -96968,10 +97557,14 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string" + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" }, "homepage": { "type": "string", + "format": "uri", + "example": "https://github.com", "nullable": true }, "language": { @@ -96979,26 +97572,36 @@ "nullable": true }, "forks_count": { - "type": "integer" + "type": "integer", + "example": 9 }, "stargazers_count": { - "type": "integer" + "type": "integer", + "example": 80 }, "watchers_count": { - "type": "integer" + "type": "integer", + "example": 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" + "type": "integer", + "example": 108 }, "default_branch": { - "type": "string" + "description": "The default branch of the repository.", + "type": "string", + "example": "master" }, "open_issues_count": { - "type": "integer" + "type": "integer", + "example": 0 }, "is_template": { - "type": "boolean" + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true }, "topics": { "type": "array", @@ -97007,30 +97610,51 @@ } }, "has_issues": { - "type": "boolean" + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_projects": { - "type": "boolean" + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_wiki": { - "type": "boolean" + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, "has_pages": { "type": "boolean" }, "has_downloads": { - "type": "boolean" + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true }, "has_discussions": { - "type": "boolean" + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { - "type": "boolean" + "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": { @@ -97051,226 +97675,122 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, "delete_branch_on_merge": { - "type": "boolean" + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "subscribers_count": { - "type": "integer" + "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", + "example": false }, - "network_count": { - "type": "integer" + "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 }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] + "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)." }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true + "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." }, - "forks": { - "type": "integer", - "example": 0 + "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)." }, - "open_issues": { - "type": "integer", - "example": 0 + "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." }, - "watchers": { - "type": "integer", - "example": 0 + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": 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", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { "type": "boolean", - "example": false + "description": "Whether anonymous git access is enabled for this repository" }, - "security_and_analysis": { - "nullable": true, + "code_search_index_status": { "type": "object", + "description": "The status of the code search index for this repository", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_search_ok": { + "type": "boolean" }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "lexical_commit_sha": { + "type": "string" } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ @@ -97319,114 +97839,87 @@ "tags_url", "teams_url", "trees_url", - "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" ] } + }, + "single_file": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] } - } + }, + "required": [ + "token", + "expires_at" + ] }, "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - } - ] + "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-29T12:13:35.123-08:00" } } } } } - }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - }, - "put": { - "summary": "Set selected repositories for an organization variable", - "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for an organization", + "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/set-selected-repos-for-org-variable", + "operationId": "actions/get-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -97439,73 +97932,150 @@ } }, { - "name": "name", - "description": "The name of the variable.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "The IDs of the repositories that can access the organization variable.", - "items": { - "type": "integer" + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + }, + "ephemeral": { + "type": "boolean" } - } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] }, - "required": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] + "examples": { + "default": { + "value": { + "id": 23, + "name": "MBP", + "os": "macos", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } } } } } } }, - "responses": { - "204": { - "description": "Response" - }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" - } - }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { - "put": { - "summary": "Add selected repository to an organization variable", - "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + }, + "delete": { + "summary": "Delete a self-hosted runner from an organization", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], - "operationId": "actions/add-selected-repo-to-org-variable", + "operationId": "actions/delete-self-hosted-runner-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" }, "parameters": [ { @@ -97518,16 +98088,8 @@ } }, { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { @@ -97539,27 +98101,56 @@ "204": { "description": "Response" }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "actions", - "subcategory": "variables" + "subcategory": "self-hosted-runners" } - }, - "delete": { - "summary": "Remove selected repository from an organization variable", - "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + } + }, + "/orgs/{org}/actions/runners/{runner_id}/labels": { + "get": { + "summary": "List labels for a self-hosted runner for an organization", + "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], - "operationId": "actions/remove-selected-repo-from-org-variable", + "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -97572,16 +98163,8 @@ } }, { - "name": "name", - "description": "The name of the variable.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { @@ -97589,216 +98172,104 @@ } } ], - "responses": { - "204": { - "description": "Response" - }, - "409": { - "description": "Response when the visibility of the variable is not set to `selected`" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "actions", - "subcategory": "variables" - } - } - }, - "/orgs/{org}/announcement": { - "get": { - "summary": "Get announcement banner for organization", - "description": "Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.", - "tags": [ - "orgs" - ], - "operationId": "announcement-banners/get-announcement-banner-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-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": "Announcement Banner", - "description": "Announcement at either the repository, organization, or enterprise level", "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "announcement": { - "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "example": "Very **important** announcement about _something_.", - "nullable": true - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "example": "\"2021-01-01T00:00:00.000-07:00\"", - "nullable": true + "total_count": { + "type": "integer" }, - "user_dismissible": { - "type": "boolean", - "description": "Whether an announcement can be dismissed by the user.", - "example": false, - "nullable": true, - "default": false + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } } - }, - "required": [ - "announcement", - "expires_at", - "user_dismissible" - ] + } }, "examples": { "default": { - "summary": "Announcement banner", "value": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } } } } } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "announcement-banners", - "subcategory": "organizations" - } - }, - "patch": { - "summary": "Set announcement banner for organization", - "description": "Sets the announcement banner to display for the organization.", - "tags": [ - "orgs" - ], - "operationId": "announcement-banners/set-announcement-banner-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#set-announcement-banner-for-organization" - }, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "Enterprise Announcement", - "description": "Enterprise global announcement", - "type": "object", - "properties": { - "announcement": { - "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "example": "Very **important** announcement about _something_.", - "nullable": true - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "example": "\"2021-01-01T00:00:00.000-07:00\"", - "nullable": true - }, - "user_dismissible": { - "type": "boolean", - "description": "Whether an announcement can be dismissed by the user.", - "example": false, - "nullable": true, - "default": false - } - }, - "required": [ - "announcement" - ] - }, - "examples": { - "default": { - "summary": "Announcement banner", - "value": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false - } - } - } - } - } - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Announcement Banner", - "description": "Announcement at either the repository, organization, or enterprise level", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "announcement": { - "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "example": "Very **important** announcement about _something_.", - "nullable": true + "message": { + "type": "string" }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "example": "\"2021-01-01T00:00:00.000-07:00\"", - "nullable": true + "documentation_url": { + "type": "string" }, - "user_dismissible": { - "type": "boolean", - "description": "Whether an announcement can be dismissed by the user.", - "example": false, - "nullable": true, - "default": false - } - }, - "required": [ - "announcement", - "expires_at", - "user_dismissible" - ] - }, - "examples": { - "default": { - "summary": "Announcement banner", - "value": { - "announcement": "Very **important** announcement about _something_.", - "expires_at": "2021-01-01T00:00:00.000+00:00", - "user_dismissible": false + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -97807,22 +98278,22 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "announcement-banners", - "subcategory": "organizations" + "category": "actions", + "subcategory": "self-hosted-runners" } }, - "delete": { - "summary": "Remove announcement banner from organization", - "description": "Removes the announcement banner currently set for the organization.", + "post": { + "summary": "Add custom labels to a self-hosted runner for an organization", + "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "announcement-banners/remove-announcement-banner-for-org", + "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -97833,68 +98304,14 @@ "schema": { "type": "string" } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "announcement-banners", - "subcategory": "organizations" - } - } - }, - "/orgs/{org}/attestations/bulk-list": { - "post": { - "summary": "List attestations by bulk subject digests", - "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-attestations-bulk", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations-by-bulk-subject-digests" - }, - "parameters": [ - { - "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": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, - "schema": { - "type": "string" - } }, { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -97904,42 +98321,29 @@ "application/json": { "schema": { "type": "object", + "required": [ + "labels" + ], "properties": { - "subject_digests": { + "labels": { "type": "array", + "minItems": 1, + "maxItems": 100, + "description": "The names of the custom labels to add to the runner.", "items": { "type": "string" - }, - "description": "List of subject digests to fetch attestations for.", - "minItems": 1, - "maxItems": 1024 - }, - "predicate_type": { - "type": "string", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types." + } } - }, - "required": [ - "subject_digests" - ] + } }, "examples": { "default": { "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" + "labels": [ + "gpu", + "accelerated" ] } - }, - "withPredicateType": { - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ], - "predicateType": "provenance" - } } } } @@ -97952,198 +98356,69 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "attestations_subject_digests": { - "type": "object", - "additionalProperties": { - "nullable": true, - "type": "array", - "items": { - "type": "object", - "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The bundle of the attestation." - }, - "repository_id": { - "type": "integer" - }, - "bundle_url": { - "type": "string" - } - } - } - }, - "description": "Mapping of subject digest to bundles." + "total_count": { + "type": "integer" }, - "page_info": { - "type": "object", - "properties": { - "has_next": { - "type": "boolean", - "description": "Indicates whether there is a next page." - }, - "has_previous": { - "type": "boolean", - "description": "Indicates whether there is a previous page." - }, - "next": { - "type": "string", - "description": "The cursor to the next page." + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } }, - "previous": { - "type": "string", - "description": "The cursor to the previous page." - } - }, - "description": "Information about the current page." + "required": [ + "name" + ] + } } } }, "examples": { "default": { "value": { - "attestations_subject_digests": [ + "total_count": 4, + "labels": [ { - "sha256:abc": [ - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - }, - { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 - } - ] + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" } ] } @@ -98151,27 +98426,81 @@ } } } + }, + "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 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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/attestations/delete-request": { - "post": { - "summary": "Delete attestations in bulk", - "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + }, + "put": { + "summary": "Set custom labels for a self-hosted runner for an organization", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-attestations-bulk", + "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -98182,6 +98511,15 @@ "schema": { "type": "string" } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -98190,58 +98528,27 @@ "application/json": { "schema": { "type": "object", - "oneOf": [ - { - "properties": { - "subject_digests": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of subject digests associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } - }, - "required": [ - "subject_digests" - ] - }, - { - "properties": { - "attestation_ids": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "List of unique IDs associated with the artifact attestations to delete.", - "minItems": 1, - "maxItems": 1024 - } - }, - "required": [ - "attestation_ids" - ] - } + "required": [ + "labels" ], - "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + "properties": { + "labels": { + "type": "array", + "minItems": 0, + "maxItems": 100, + "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", + "items": { + "type": "string" + } + } + } }, "examples": { - "by-subject-digests": { - "summary": "Delete by subject digests", - "value": { - "subject_digests": [ - "sha256:abc123", - "sha512:def456" - ] - } - }, - "by-attestation-ids": { - "summary": "Delete by attestation IDs", + "default": { "value": { - "attestation_ids": [ - 111, - 222 + "labels": [ + "gpu", + "accelerated" ] } } @@ -98251,7 +98558,81 @@ }, "responses": { "200": { - "description": "Response" + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + } + } + } + } }, "404": { "description": "Resource not found", @@ -98278,64 +98659,19 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" - } - } - }, - "/orgs/{org}/attestations/digest/{subject_digest}": { - "delete": { - "summary": "Delete attestations by subject digest", - "description": "Delete an artifact attestation by subject digest.", - "tags": [ - "orgs" - ], - "operationId": "orgs/delete-attestations-by-subject-digest", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "subject_digest", - "description": "Subject Digest", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "responses": { - "200": { - "description": "Response" - }, - "204": { - "description": "Response" }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -98343,11 +98679,11 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "type": "string" + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -98358,22 +98694,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" + "category": "actions", + "subcategory": "self-hosted-runners" } - } - }, - "/orgs/{org}/attestations/{attestation_id}": { + }, "delete": { - "summary": "Delete attestations by ID", - "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.", + "summary": "Remove all custom labels from a self-hosted runner for an organization", + "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-attestations-by-id", + "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -98386,8 +98720,8 @@ } }, { - "name": "attestation_id", - "description": "Attestation ID", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { @@ -98397,31 +98731,71 @@ ], "responses": { "200": { - "description": "Response" - }, - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "total_count": { + "type": "integer" }, - "status": { - "type": "string" + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + } + ] } } } @@ -98458,51 +98832,24 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "attestations" + "category": "actions", + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/attestations/{subject_digest}": { - "get": { - "summary": "List attestations", - "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + "delete": { + "summary": "Remove a custom label from a self-hosted runner for an organization", + "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-attestations", + "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ - { - "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": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", - "required": false, - "schema": { - "type": "string" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -98513,20 +98860,19 @@ } }, { - "name": "subject_digest", - "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" - }, - "x-multi-segment": true + "type": "integer" + } }, { - "name": "predicate_type", - "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", - "in": "query", - "required": false, + "name": "name", + "description": "The name of a self-hosted runner's custom label.", + "in": "path", + "required": true, "schema": { "type": "string" } @@ -98539,38 +98885,41 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "labels" + ], "properties": { - "attestations": { + "total_count": { + "type": "integer" + }, + "labels": { "type": "array", "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", "type": "object", "properties": { - "bundle": { - "type": "object", - "properties": { - "mediaType": { - "type": "string" - }, - "verificationMaterial": { - "type": "object", - "properties": {}, - "additionalProperties": true - }, - "dsseEnvelope": { - "type": "object", - "properties": {}, - "additionalProperties": true - } - }, - "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + "id": { + "type": "integer", + "description": "Unique identifier of the label." }, - "repository_id": { - "type": "integer" + "name": { + "type": "string", + "description": "Name of the label." }, - "bundle_url": { - "type": "string" + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] } - } + }, + "required": [ + "name" + ] } } } @@ -98578,128 +98927,27 @@ "examples": { "default": { "value": { - "attestations": [ + "total_count": 4, + "labels": [ { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 + "id": 5, + "name": "self-hosted", + "type": "read-only" }, { - "bundle": { - "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", - "verificationMaterial": { - "tlogEntries": [ - { - "logIndex": "97913980", - "logId": { - "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" - }, - "kindVersion": { - "kind": "dsse", - "version": "0.0.1" - }, - "integratedTime": "1716998992", - "inclusionPromise": { - "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" - }, - "inclusionProof": { - "logIndex": "93750549", - "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", - "treeSize": "93750551", - "hashes": [ - "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", - "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", - "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", - "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", - "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", - "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", - "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", - "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", - "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", - "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", - "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", - "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", - "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" - ], - "checkpoint": { - "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" - } - }, - "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" - } - ], - "timestampVerificationData": {}, - "certificate": { - "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" - } - }, - "dsseEnvelope": { - "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", - "payloadType": "application/vnd.in-toto+json", - "signatures": [ - { - "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" - } - ] - } - }, - "repository_id": 1 + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" } ] } @@ -98707,27 +98955,83 @@ } } } + }, + "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 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" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "self-hosted-runners" } } }, - "/orgs/{org}/audit-log": { + "/orgs/{org}/actions/secrets": { "get": { - "summary": "Get the audit log for an organization", - "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", - "operationId": "orgs/get-audit-log", + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], + "operationId": "actions/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets" }, "parameters": [ { @@ -98740,66 +99044,21 @@ } }, { - "name": "phrase", - "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "include", - "description": "The event types to include:\n\n- `web` - returns web (non-Git) events.\n- `git` - returns Git events.\n- `all` - returns both web and Git events.\n\nThe default is `web`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "web", - "git", - "all" - ] - } - }, - { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "order", - "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.", + "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", - "required": false, "schema": { - "type": "string", - "enum": [ - "desc", - "asc" - ] + "type": "integer", + "default": 30 } }, { - "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).\"", + "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": 30 + "default": 1 } } ], @@ -98809,230 +99068,119 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "@timestamp": { - "type": "integer", - "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "action": { - "type": "string", - "description": "The name of the action that was performed, for example `user.login` or `repo.create`." - }, - "active": { - "type": "boolean" - }, - "active_was": { - "type": "boolean" - }, - "actor": { - "type": "string", - "description": "The actor who performed the action." - }, - "actor_id": { - "type": "integer", - "description": "The id of the actor who performed the action." - }, - "actor_location": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { - "country_name": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" } - } - }, - "data": { - "type": "object", - "additionalProperties": true - }, - "org_id": { - "type": "integer" - }, - "user_id": { - "type": "integer" - }, - "business_id": { - "type": "integer" - }, - "blocked_user": { - "type": "string", - "description": "The username of the account being blocked." - }, - "business": { - "type": "string" - }, - "config": { - "type": "array", - "items": { - "type": "object" - } - }, - "config_was": { - "type": "array", - "items": { - "type": "object" - } - }, - "content_type": { - "type": "string" - }, - "operation_type": { - "type": "string" - }, - "created_at": { - "type": "integer", - "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "deploy_key_fingerprint": { - "type": "string" - }, - "_document_id": { - "type": "string", - "description": "A unique identifier for an audit event." - }, - "emoji": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "object" - } - }, - "events_were": { - "type": "array", - "items": { - "type": "object" - } - }, - "explanation": { - "type": "string" - }, - "fingerprint": { - "type": "string" - }, - "hook_id": { - "type": "integer" - }, - "limited_availability": { - "type": "boolean" - }, - "message": { - "type": "string" - }, - "name": { - "type": "string" - }, - "old_user": { - "type": "string" - }, - "openssh_public_key": { - "type": "string" - }, - "org": { - "type": "string" - }, - "previous_visibility": { - "type": "string" - }, - "read_only": { - "type": "boolean" - }, - "repo": { - "type": "string", - "description": "The name of the repository." - }, - "repository": { - "type": "string", - "description": "The name of the repository." - }, - "repository_public": { - "type": "boolean" - }, - "target_login": { - "type": "string" - }, - "team": { - "type": "string" - }, - "transport_protocol": { - "type": "integer", - "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "transport_protocol_name": { - "type": "string", - "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "user": { - "type": "string", - "description": "The user that was affected by the action performed (if available)." - }, - "visibility": { - "type": "string", - "description": "The repository visibility, for example `public` or `private`." + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] } } } }, "examples": { "default": { - "value": [ - { - "@timestamp": 1606929874512, - "action": "team.add_member", - "actor": "octocat", - "created_at": 1606929874512, - "_document_id": "xJJFlFOhQ6b-5vaAFy9Rjw", - "org": "octo-corp", - "team": "octo-corp/example-team", - "user": "monalisa" - }, - { - "@timestamp": 1606507117008, - "action": "org.create", - "actor": "octocat", - "created_at": 1606507117008, - "_document_id": "Vqvg6kZ4MYqwWRKFDzlMoQ", - "org": "octocat-test-org" - }, - { - "@timestamp": 1605719148837, - "action": "repo.destroy", - "actor": "monalisa", - "created_at": 1605719148837, - "_document_id": "LwW2vpJZCDS-WUmo9Z-ifw", - "org": "mona-org", - "repo": "mona-org/mona-test-repo", - "visibility": "private" - } - ] + "value": { + "total_count": 3, + "secrets": [ + { + "name": "GIST_ID", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "DEPLOY_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + } + ] + } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "orgs" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/blocks": { + "/orgs/{org}/actions/secrets/public-key": { "get": { - "summary": "List users blocked by an organization", - "description": "List the users blocked by an organization.", + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-blocked-users", + "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -99043,24 +99191,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": { @@ -99069,156 +99199,48 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" }, - "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" - ] - } + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] }, "examples": { "default": { - "value": [ - { - "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 - } - ] + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } } } } @@ -99228,22 +99250,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/blocks/{username}": { + "/orgs/{org}/actions/secrets/{secret_name}": { "get": { - "summary": "Check if a user is blocked by an organization", - "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/check-blocked-user", + "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret" }, "parameters": [ { @@ -99256,8 +99278,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -99266,29 +99288,58 @@ } ], "responses": { - "204": { - "description": "If the user is blocked" - }, - "404": { - "description": "If the user is not blocked", + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", "type": "string" }, - "documentation_url": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "url": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time" }, - "status": { + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } } } @@ -99299,20 +99350,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } }, "put": { - "summary": "Block a user from an organization", - "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/block-user", + "operationId": "actions/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret" }, "parameters": [ { @@ -99325,8 +99376,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -99334,75 +99385,975 @@ } } ], - "responses": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "encrypted_value", + "key_id", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { "204": { "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + }, + "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": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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 + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "repositories" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "repositories": { "type": "array", "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "field": { + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "message": { + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, - "code": { + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { "type": "string" }, - "index": { + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { "type": "integer" }, - "value": { - "oneOf": [ - { + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "nullable": true + "example": "contributor_covenant" }, - { - "type": "integer", + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } } } - ] + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } + }, + "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" + ] } } } + }, + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + } } } } @@ -99411,20 +100362,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } }, - "delete": { - "summary": "Unblock a user from an organization", - "description": "Unblocks the given user on behalf of the specified organization.", + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/unblock-user", + "operationId": "actions/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -99437,8 +100388,8 @@ } }, { - "name": "username", - "description": "The handle for the GitHub user account.", + "name": "secret_name", + "description": "The name of the secret.", "in": "path", "required": true, "schema": { @@ -99446,6 +100397,37 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, "responses": { "204": { "description": "Response" @@ -99454,28 +100436,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "blocking" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/bypass-requests/push-rules": { - "get": { - "summary": "List push rule bypass requests within an organization", - "description": "Lists the requests made by users of a repository to bypass push protection rules within an organization.", + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-push-bypass-requests", + "operationId": "actions/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization" - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "bypass-requests" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -99488,74 +100464,122 @@ } }, { - "name": "repository_name", - "description": "The name of the repository to filter on.", - "in": "query", + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "reviewer", - "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", - "in": "query", - "required": false, + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "requester", - "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", - "in": "query", - "required": false, + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "time_period", - "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", - "in": "query", - "required": false, + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "day" + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/variables": { + "get": { + "summary": "List organization variables", + "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-org-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables" + }, + "parameters": [ { - "name": "request_status", - "description": "The status of the bypass request to filter on. When specified, only requests with this status will be returned.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "completed", - "cancelled", - "approved", - "expired", - "deleted", - "denied", - "open", - "all" - ], - "default": "all" + "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).\"", + "description": "The number of results per page (max 30). 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 + "default": 10 } }, { @@ -99574,362 +100598,345 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Push rule bypass request", - "description": "A bypass request made by a user asking to be exempted from a push rule in this repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the bypass request." - }, - "number": { - "type": "integer", - "description": "The number uniquely identifying the bypass request within its repository." - }, - "repository": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", - "description": "The repository the bypass request is for.", "properties": { - "id": { - "type": "integer", - "description": "The ID of the repository the bypass request is for.", - "nullable": true - }, "name": { - "type": "string", - "description": "The name of the repository the bypass request is for.", - "nullable": true + "description": "The name of the variable.", + "example": "USERNAME", + "type": "string" }, - "full_name": { + "value": { + "description": "The value of the variable.", + "example": "octocat", + "type": "string" + }, + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", "type": "string", - "description": "The full name of the repository the bypass request is for.", - "nullable": true - } - } - }, - "organization": { - "type": "object", - "description": "The organization associated with the repository the bypass request is for.", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the organization.", - "nullable": true + "format": "date-time" }, - "name": { + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", "type": "string", - "description": "The name of the organization.", - "nullable": true - } - } - }, - "requester": { - "type": "object", - "description": "The user who requested the bypass.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who requested the bypass." + "format": "date-time" }, - "actor_name": { + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { "type": "string", - "description": "The name of the GitHub user who requested the bypass." - } - } - }, - "request_type": { - "type": "string", - "description": "The type of request." - }, - "data": { - "nullable": true, - "type": "array", - "description": "Data describing the push rules that are being requested to be bypassed.", - "items": { - "type": "object", - "properties": { - "ruleset_id": { - "type": "integer", - "description": "The ID of the ruleset for the rules that were violated." - }, - "ruleset_name": { - "type": "string", - "description": "The name of the ruleset for the rules that were violated." - }, - "total_violations": { - "type": "integer", - "description": "The number of rule violations generated from the push associated with this request." - }, - "rule_type": { - "type": "string", - "description": "The type of rule that was violated." - } + "format": "uri", + "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" } - } - }, - "resource_identifier": { - "type": "string", - "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", - "example": "827efc6d56897b048c772eb4087f854f46256132" - }, - "status": { - "type": "string", - "description": "The status of the bypass request.", - "enum": [ - "pending", - "denied", - "approved", - "cancelled", - "completed", - "expired", - "deleted", - "open" + }, + "required": [ + "name", + "value", + "created_at", + "updated_at", + "visibility" ] - }, - "requester_comment": { - "type": "string", - "description": "The comment the requester provided when creating the bypass request.", - "nullable": true - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the bypass request will expire." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the bypass request was created." - }, - "responses": { - "type": "array", - "description": "The responses to the bypass request.", - "nullable": true, - "items": { - "title": "Bypass response", - "description": "A response made by a delegated bypasser to a bypass request.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the response to the bypass request." - }, - "reviewer": { - "type": "object", - "description": "The user who reviewed the bypass request.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who reviewed the bypass request." - }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who reviewed the bypass request." - } - } - }, - "status": { - "type": "string", - "description": "The response status to the bypass request until dismissed.", - "enum": [ - "approved", - "denied", - "dismissed" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the response to the bypass request was created." - } - } - } - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1" - }, - "html_url": { - "type": "string", - "description": "The URL to view the bypass request in a browser.", - "format": "uri", - "example": "https://github.com/octo-org/smile/exemptions/1" } } } }, "examples": { "default": { - "value": [ - { - "id": 21, - "number": 42, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" - }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" - }, - "request_type": "push_ruleset_bypass", - "data": [ - { - "ruleset_id": 410, - "ruleset_name": "Exclude image files", - "total_violations": 1, - "rule_type": "file_extension_restriction" - } - ], - "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", - "status": "denied", - "requester_comment": "Updating site images to follow changes in marketing. Part 1", - "expires_at": "2024-07-08T08:43:03Z", - "created_at": "2024-07-01T08:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1", - "html_url": "https://github.com/octo-org/smile/exemptions/1" - }, - { - "id": 12, - "number": 24, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" + "value": { + "total_count": 3, + "variables": [ + { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" + { + "name": "ACTIONS_RUNNER_DEBUG", + "value": true, + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" }, - "request_type": "push_ruleset_bypass", - "data": [ - { - "ruleset_id": 410, - "ruleset_name": "Exclude image files", - "total_violations": 1, - "rule_type": "file_extension_restriction" - } - ], - "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", - "status": "denied", - "requester_comment": "Updating site images to follow changes in marketing. Part 2", - "expires_at": "2024-07-08T07:43:03Z", - "created_at": "2024-07-01T07:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2", - "html_url": "https://github.com/octo-org/smile/exemptions/2" - } + { + "name": "ADMIN_EMAIL", + "value": "octocat@github.com", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "post": { + "summary": "Create an organization variable", + "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable" + }, + "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": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + }, + "visibility": { + "type": "string", + "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "name", + "value", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 ] } } } } - }, - "404": { - "description": "Resource not found", + } + }, + "responses": { + "201": { + "description": "Response when creating a variable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}": { + "get": { + "summary": "Get an organization variable", + "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "500": { - "description": "Internal Error", + { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the variable.", + "example": "USERNAME", "type": "string" }, - "documentation_url": { + "value": { + "description": "The value of the variable.", + "example": "octocat", "type": "string" }, - "url": { - "type": "string" + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", + "type": "string", + "format": "date-time" }, - "status": { + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" } } } } } } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" } - } - }, - "/orgs/{org}/bypass-requests/secret-scanning": { - "get": { - "summary": "List bypass requests for secret scanning for an org", - "description": "List requests to bypass secret scanning push protection in an org.\n\nDelegated bypass must be enabled on repositories in the org and the user must be a bypass reviewer to access this endpoint.\nPersonal access tokens (classic) need the `security_events` scope to use this endpoint.", + }, + "patch": { + "summary": "Update an organization variable", + "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ - "secret-scanning" + "actions" ], - "operationId": "secret-scanning/list-org-bypass-requests", + "operationId": "actions/update-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org" - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "secret-scanning", - "subcategory": "delegated-bypass" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable" }, "parameters": [ { @@ -99942,83 +100949,167 @@ } }, { - "name": "repository_name", - "description": "The name of the repository to filter on.", - "in": "query", + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { "type": "string" } - }, + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + }, + "visibility": { + "type": "string", + "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Delete an organization variable", + "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable" + }, + "parameters": [ { - "name": "reviewer", - "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "requester", - "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", - "in": "query", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { "type": "string" } - }, + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}/repositories": { + "get": { + "summary": "List selected repositories for an organization variable", + "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable" + }, + "parameters": [ { - "name": "time_period", - "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "day" + "type": "string" } }, { - "name": "request_status", - "description": "The status of the bypass request to filter on. When specified, only requests with this status will be returned.", - "in": "query", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "completed", - "cancelled", - "approved", - "expired", - "deleted", - "denied", - "open", - "all" - ], - "default": "all" + "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).\"", + "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": 30 + "default": 1 } }, { - "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).\"", + "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": 1 + "default": 30 } } ], @@ -100028,355 +101119,893 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Secret scanning bypass request", - "description": "A bypass request made by a user asking to be exempted from push protection in this repository.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the bypass request." - }, - "number": { - "type": "integer", - "description": "The number uniquely identifying the bypass request within its repository." - }, - "repository": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", - "description": "The repository the bypass request is for.", "properties": { "id": { "type": "integer", - "description": "The ID of the repository the bypass request is for." - }, - "name": { - "type": "string", - "description": "The name of the repository the bypass request is for." + "format": "int64", + "example": 1296269 }, - "full_name": { + "node_id": { "type": "string", - "description": "The full name of the repository the bypass request is for." - } - } - }, - "organization": { - "type": "object", - "description": "The organization associated with the repository the bypass request is for.", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the organization." + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { "type": "string", - "description": "The name of the organization." - } - } - }, - "requester": { - "type": "object", - "description": "The user who requested the bypass.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who requested the bypass." + "example": "Hello-World" }, - "actor_name": { + "full_name": { "type": "string", - "description": "The name of the GitHub user who requested the bypass." - } - } - }, - "request_type": { - "type": "string", - "description": "The type of request." - }, - "data": { - "nullable": true, - "type": "array", - "description": "Data describing the push rules that are being requested to be bypassed.", - "items": { - "type": "object", - "properties": { - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "bypass_reason": { - "type": "string", - "enum": [ - "used_in_tests", - "false_positive", - "fix_later" - ], - "description": "The reason the bypass was requested." - }, - "path": { - "type": "string", - "description": "The path in the repo where the secret was located during the request." - }, - "branch": { - "type": "string", - "description": "The branch in the repo where the secret was located during the request." - } - } - } - }, - "resource_identifier": { - "type": "string", - "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", - "example": "827efc6d56897b048c772eb4087f854f46256132" - }, - "status": { - "type": "string", - "description": "The status of the bypass request.", - "enum": [ - "pending", - "denied", - "approved", - "cancelled", - "completed", - "expired", - "open" - ] - }, - "requester_comment": { - "type": "string", - "description": "The comment the requester provided when creating the bypass request.", - "nullable": true - }, - "expires_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the bypass request will expire." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the bypass request was created." - }, - "responses": { - "type": "array", - "description": "The responses to the bypass request.", - "nullable": true, - "items": { - "title": "Bypass response", - "description": "A response made by a delegated bypasser to a bypass request.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the response to the bypass request." + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "reviewer": { - "type": "object", - "description": "The user who reviewed the bypass request.", - "properties": { - "actor_id": { - "type": "integer", - "description": "The ID of the GitHub user who reviewed the bypass request." - }, - "actor_name": { - "type": "string", - "description": "The name of the GitHub user who reviewed the bypass request." - } + "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true } }, - "status": { - "type": "string", - "description": "The response status to the bypass request until dismissed.", - "enum": [ - "approved", - "denied", - "dismissed" - ] + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the response to the bypass request was created." + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1" - }, - "html_url": { - "type": "string", - "description": "The URL to view the bypass request in a browser.", - "format": "uri", - "example": "https://github.com/octo-org/smile/exemptions/1" + }, + "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" + ] } } } }, "examples": { "default": { - "value": [ - { - "id": 21, - "number": 42, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" - }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" - }, - "request_type": "secret_scanning", - "data": [ - { - "secret_type": "adafruit_io_key", - "bypass_reason": "used_in_tests", - "path": "/tests/README.md:16:0", - "branch": "refs/heads/main" - } - ], - "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", - "status": "denied", - "requester_comment": "Test token used in the readme as an example", - "expires_at": "2024-07-08T08:43:03Z", - "created_at": "2024-07-01T08:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1", - "html_url": "https://github.com/octo-org/smile/exemptions/1" - }, - { - "id": 12, - "number": 24, - "repository": { - "id": 1, - "name": "smile", - "full_name": "octo-org/smile" - }, - "organization": { - "id": 1, - "name": "octo-org" - }, - "requester": { - "actor_id": 12, - "actor_name": "monalisa" - }, - "request_type": "secret_scanning", - "data": [ - { - "secret_type": "adafruit_io_key", - "bypass_reason": "fix_later", - "path": "README.md:17:0", - "branch": "refs/heads/my-branch" - } - ], - "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", - "status": "denied", - "requester_comment": "Token is already revoked, I'll remove it later", - "expires_at": "2024-07-08T07:43:03Z", - "created_at": "2024-07-01T07:43:03Z", - "responses": [ - { - "id": 42, - "reviewer": { - "actor_id": 4, - "actor_name": "octocat" - }, - "status": "denied", - "created_at": "2024-07-02T08:43:04Z" - } - ], - "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/2", - "html_url": "https://github.com/octo-org/smile/exemptions/2" - } - ] + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } } } } } }, - "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": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "put": { + "summary": "Set selected repositories for an organization variable", + "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/set-selected-repos-for-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "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" + { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "The IDs of the repositories that can access the organization variable.", + "items": { + "type": "integer" } } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } } } } } + }, + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" } } }, - "/orgs/{org}/campaigns": { - "get": { - "summary": "List campaigns for an organization", - "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization variable", + "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ - "campaigns" + "actions" ], - "operationId": "campaigns/list-org-campaigns", + "operationId": "actions/add-selected-repo-to-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable" }, "parameters": [ { @@ -100389,66 +102018,113 @@ } }, { - "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", + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "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", + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response" }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Remove selected repository from an organization variable", + "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable" + }, + "parameters": [ { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" + "type": "string" } }, { - "name": "state", - "description": "If specified, only campaigns with this state will be returned.", - "in": "query", - "required": false, + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, "schema": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] + "type": "string" } }, { - "name": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "ends_at", - "published" - ], - "default": "created" + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/announcement": { + "get": { + "summary": "Get announcement banner for organization", + "description": "Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.", + "tags": [ + "orgs" + ], + "operationId": "announcement-banners/get-announcement-banner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], @@ -100458,527 +102134,171 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] - } + "title": "Announcement Banner", + "description": "Announcement at either the repository, organization, or enterprise level", + "type": "object", + "properties": { + "announcement": { + "type": "string", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "example": "Very **important** announcement about _something_.", + "nullable": true }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] - } + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", + "example": "\"2021-01-01T00:00:00.000-07:00\"", + "nullable": true + }, + "user_dismissible": { + "type": "boolean", + "description": "Whether an announcement can be dismissed by the user.", + "example": false, + "nullable": true, + "default": false + } + }, + "required": [ + "announcement", + "expires_at", + "user_dismissible" + ] }, "examples": { "default": { - "value": [ - { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - { - "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 - } - ], - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open" - }, - { - "number": 4, - "created_at": "2024-03-30T12:29:18Z", - "updated_at": "2024-03-30T12:29:18Z", - "name": "Mitre top 10 KEV", - "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.", - "managers": [ - { - "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 - } - ], - "ends_at": "2024-04-30T12:29:18Z", - "closed_at": null, - "state": "open" - } - ] + "summary": "Announcement banner", + "value": { + "announcement": "Very **important** announcement about _something_.", + "expires_at": "2021-01-01T00:00:00.000+00:00", + "user_dismissible": false + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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": true, + "enabledForGitHubApps": true, + "category": "announcement-banners", + "subcategory": "organizations" + } + }, + "patch": { + "summary": "Set announcement banner for organization", + "description": "Sets the announcement banner to display for the organization.", + "tags": [ + "orgs" + ], + "operationId": "announcement-banners/set-announcement-banner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#set-announcement-banner-for-organization" + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Enterprise Announcement", + "description": "Enterprise global announcement", + "type": "object", + "properties": { + "announcement": { + "type": "string", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "example": "Very **important** announcement about _something_.", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", + "example": "\"2021-01-01T00:00:00.000-07:00\"", + "nullable": true + }, + "user_dismissible": { + "type": "boolean", + "description": "Whether an announcement can be dismissed by the user.", + "example": false, + "nullable": true, + "default": false + } + }, + "required": [ + "announcement" + ] + }, + "examples": { + "default": { + "summary": "Announcement banner", + "value": { + "announcement": "Very **important** announcement about _something_.", + "expires_at": "2021-01-01T00:00:00.000+00:00", + "user_dismissible": false } } } } - }, - "503": { - "description": "Service unavailable", + } + }, + "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": "Announcement Banner", + "description": "Announcement at either the repository, organization, or enterprise level", "type": "object", "properties": { - "code": { - "type": "string" + "announcement": { + "type": "string", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "example": "Very **important** announcement about _something_.", + "nullable": true }, - "message": { - "type": "string" + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", + "example": "\"2021-01-01T00:00:00.000-07:00\"", + "nullable": true }, - "documentation_url": { - "type": "string" + "user_dismissible": { + "type": "boolean", + "description": "Whether an announcement can be dismissed by the user.", + "example": false, + "nullable": true, + "default": false + } + }, + "required": [ + "announcement", + "expires_at", + "user_dismissible" + ] + }, + "examples": { + "default": { + "summary": "Announcement banner", + "value": { + "announcement": "Very **important** announcement about _something_.", + "expires_at": "2021-01-01T00:00:00.000+00:00", + "user_dismissible": false } } } @@ -100987,24 +102307,87 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "announcement-banners", + "subcategory": "organizations" } }, + "delete": { + "summary": "Remove announcement banner from organization", + "description": "Removes the announcement banner currently set for the organization.", + "tags": [ + "orgs" + ], + "operationId": "announcement-banners/remove-announcement-banner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-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" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "announcement-banners", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/attestations/bulk-list": { "post": { - "summary": "Create a campaign for an organization", - "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.", + "summary": "List attestations by bulk subject digests", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ - "campaigns" + "orgs" ], - "operationId": "campaigns/create-campaign", + "operationId": "orgs/list-attestations-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations-by-bulk-subject-digests" }, "parameters": [ + { + "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": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -101021,108 +102404,42 @@ "application/json": { "schema": { "type": "object", - "additionalProperties": false, "properties": { - "name": { - "description": "The name of the campaign", - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "description": { - "description": "A description for the campaign", - "type": "string", - "minLength": 1, - "maxLength": 255 - }, - "managers": { - "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", - "type": "array", - "maxItems": 10, - "items": { - "description": "The login of each manager", - "type": "string" - } - }, - "team_managers": { - "description": "The slugs of the teams to set as the campaign managers.", + "subject_digests": { "type": "array", - "maxItems": 10, "items": { - "description": "The slug of each team", "type": "string" - } - }, - "ends_at": { - "description": "The end date and time of the campaign. The date must be in the future.", - "type": "string", - "format": "date-time" - }, - "contact_link": { - "description": "The contact link of the campaign. Must be a URI.", - "type": "string", - "format": "uri", - "nullable": true - }, - "code_scanning_alerts": { - "description": "The code scanning alerts to include in this campaign", - "type": "array", + }, + "description": "List of subject digests to fetch attestations for.", "minItems": 1, - "items": { - "type": "object", - "additionalProperties": false, - "properties": { - "repository_id": { - "type": "integer", - "description": "The repository id" - }, - "alert_numbers": { - "type": "array", - "description": "The alert numbers", - "minItems": 1, - "items": { - "type": "integer" - } - } - }, - "required": [ - "repository_id", - "alert_numbers" - ] - } + "maxItems": 1024 }, - "generate_issues": { - "description": "If true, will automatically generate issues for the campaign. The default is false.", - "type": "boolean", - "default": false + "predicate_type": { + "type": "string", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types." } }, "required": [ - "name", - "description", - "ends_at", - "code_scanning_alerts" + "subject_digests" ] }, "examples": { "default": { "value": { - "name": "Critical CodeQL alerts", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - "octocat" - ], - "ends_at": "2024-03-14T00:00:00Z", - "code_scanning_alerts": [ - { - "repository_id": 1296269, - "alert_numbers": [ - 1, - 2 - ] - } + "subject_digests": [ + "sha256:abc123", + "sha512:def456" ] } + }, + "withPredicateType": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ], + "predicateType": "provenance" + } } } } @@ -101134,543 +102451,201 @@ "content": { "application/json": { "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", "type": "object", "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The bundle of the attestation." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + }, + "description": "Mapping of subject digest to bundles." }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { + "page_info": { "type": "object", - "additionalProperties": false, "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" + "has_next": { + "type": "boolean", + "description": "Indicates whether there is a next page." }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" + "has_previous": { + "type": "boolean", + "description": "Indicates whether there is a previous page." }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" + "next": { + "type": "string", + "description": "The cursor to the next page." + }, + "previous": { + "type": "string", + "description": "The cursor to the previous page." } }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] + "description": "Information about the current page." } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] + } }, "examples": { "default": { "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ + "attestations_subject_digests": [ { - "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 + "sha256:abc": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "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": "Unprocessable Entity", - "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" - } - } - } - } - } - }, - "429": { - "description": "Too Many Requests" - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + ] } } } @@ -101681,22 +102656,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "orgs", + "subcategory": "orgs" } } }, - "/orgs/{org}/campaigns/{campaign_number}": { - "get": { - "summary": "Get a campaign for an organization", - "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "/orgs/{org}/attestations/delete-request": { + "post": { + "summary": "Delete attestations in bulk", + "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", "tags": [ - "campaigns" + "orgs" ], - "operationId": "campaigns/get-campaign-summary", + "operationId": "orgs/delete-attestations-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk" }, "parameters": [ { @@ -101707,463 +102682,76 @@ "schema": { "type": "string" } - }, - { - "name": "campaign_number", - "description": "The campaign number.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "oneOf": [ + { + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" }, - "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" - ] + "description": "List of subject digests associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 } }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } + "required": [ + "subject_digests" + ] + }, + { + "properties": { + "attestation_ids": { + "type": "array", + "items": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] + "description": "List of unique IDs associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 } }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] - } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] + "required": [ + "attestation_ids" + ] + } + ], + "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + }, + "examples": { + "by-subject-digests": { + "summary": "Delete by subject digests", + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } }, - "examples": { - "default": { - "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - { - "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 - } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } - } + "by-attestation-ids": { + "summary": "Delete by attestation IDs", + "value": { + "attestation_ids": [ + 111, + 222 + ] } } } } + } + }, + "responses": { + "200": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -102190,72 +102778,27 @@ } } } - }, - "422": { - "description": "Unprocessable Entity", - "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": "campaigns", - "subcategory": "campaigns" + "category": "orgs", + "subcategory": "attestations" } - }, - "patch": { - "summary": "Update a campaign", - "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + } + }, + "/orgs/{org}/attestations/digest/{subject_digest}": { + "delete": { + "summary": "Delete attestations by subject digest", + "description": "Delete an artifact attestation by subject digest.", "tags": [ - "campaigns" + "orgs" ], - "operationId": "campaigns/update-campaign", + "operationId": "orgs/delete-attestations-by-subject-digest", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest" }, "parameters": [ { @@ -102268,556 +102811,22 @@ } }, { - "name": "campaign_number", - "description": "The campaign number.", + "name": "subject_digest", + "description": "Subject Digest", "in": "path", "required": true, "schema": { - "type": "integer" - } + "type": "string" + }, + "x-multi-segment": true } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "description": "The name of the campaign", - "type": "string", - "minLength": 1, - "maxLength": 50 - }, - "description": { - "description": "A description for the campaign", - "type": "string", - "minLength": 1, - "maxLength": 255 - }, - "managers": { - "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", - "type": "array", - "maxItems": 10, - "items": { - "type": "string" - } - }, - "team_managers": { - "description": "The slugs of the teams to set as the campaign managers.", - "type": "array", - "maxItems": 10, - "items": { - "description": "The slug of each team", - "type": "string" - } - }, - "ends_at": { - "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "contact_link": { - "description": "The contact link of the campaign. Must be a URI.", - "type": "string", - "format": "uri", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - } - } - }, - "examples": { - "default": { - "value": { - "name": "Critical CodeQL alerts" - } - } - } - } - } - }, "responses": { "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Campaign summary", - "description": "The campaign metadata and alert stats.", - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The number of the newly created campaign" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." - }, - "name": { - "type": "string", - "description": "The campaign name" - }, - "description": { - "type": "string", - "description": "The campaign description" - }, - "managers": { - "description": "The campaign managers", - "type": "array", - "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - } - }, - "team_managers": { - "description": "The campaign team managers", - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - } - }, - "published_at": { - "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "ends_at": { - "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "closed_at": { - "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", - "type": "string", - "format": "date-time", - "nullable": true - }, - "state": { - "title": "Campaign state", - "description": "Indicates whether a campaign is open or closed", - "type": "string", - "enum": [ - "open", - "closed" - ] - }, - "contact_link": { - "description": "The contact link of the campaign.", - "type": "string", - "format": "uri", - "nullable": true - }, - "alert_stats": { - "type": "object", - "additionalProperties": false, - "properties": { - "open_count": { - "type": "integer", - "description": "The number of open alerts" - }, - "closed_count": { - "type": "integer", - "description": "The number of closed alerts" - }, - "in_progress_count": { - "type": "integer", - "description": "The number of in-progress alerts" - } - }, - "required": [ - "open_count", - "closed_count", - "in_progress_count" - ] - } - }, - "required": [ - "number", - "created_at", - "updated_at", - "description", - "managers", - "ends_at", - "state", - "contact_link" - ] - }, - "examples": { - "default": { - "value": { - "number": 3, - "created_at": "2024-02-14T12:29:18Z", - "updated_at": "2024-02-14T12:29:18Z", - "name": "Critical CodeQL alert", - "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", - "managers": [ - { - "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 - } - ], - "published_at": "2024-02-14T12:29:18Z", - "ends_at": "2024-03-14T12:29:18Z", - "closed_at": null, - "state": "open", - "alert_stats": { - "open_count": 10, - "closed_count": 3, - "in_progress_count": 3 - } - } - } - } - } - } + "description": "Response" }, - "400": { - "description": "Bad Request", - "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" - } - } - } - } - } + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -102844,72 +102853,27 @@ } } } - }, - "422": { - "description": "Unprocessable Entity", - "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": "campaigns", - "subcategory": "campaigns" + "category": "orgs", + "subcategory": "attestations" } - }, + } + }, + "/orgs/{org}/attestations/{attestation_id}": { "delete": { - "summary": "Delete a campaign for an organization", - "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "summary": "Delete attestations by ID", + "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.", "tags": [ - "campaigns" + "orgs" ], - "operationId": "campaigns/delete-campaign", + "operationId": "orgs/delete-attestations-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id" }, "parameters": [ { @@ -102922,8 +102886,8 @@ } }, { - "name": "campaign_number", - "description": "The campaign number.", + "name": "attestation_id", + "description": "Attestation ID", "in": "path", "required": true, "schema": { @@ -102932,11 +102896,14 @@ } ], "responses": { + "200": { + "description": "Response" + }, "204": { - "description": "Deletion successful" + "description": "Response" }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -102961,21 +102928,26 @@ } } }, - "503": { - "description": "Service unavailable", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "code": { - "type": "string" - }, "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -102986,52 +102958,31 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "campaigns", - "subcategory": "campaigns" + "category": "orgs", + "subcategory": "attestations" } } }, - "/orgs/{org}/code-scanning/alerts": { + "/orgs/{org}/attestations/{subject_digest}": { "get": { - "summary": "List code scanning alerts for an organization", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", "tags": [ - "code-scanning" + "orgs" ], - "operationId": "code-scanning/list-alerts-for-org", + "operationId": "orgs/list-attestations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations" }, "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - } - }, - { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "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", - "required": false, "schema": { - "nullable": true, - "type": "string", - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + "type": "integer", + "default": 30 } }, { @@ -103053,84 +103004,31 @@ } }, { - "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 - } - }, - { - "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": "direction", - "description": "The direction to sort the results by.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, - { - "name": "state", - "description": "If specified, only code scanning alerts with this state will be returned.", - "in": "query", - "required": false, + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" - ] + "type": "string" } }, { - "name": "sort", - "description": "The property by which to sort the results.", - "in": "query", - "required": false, + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "created", - "updated" - ], - "default": "created" - } + "type": "string" + }, + "x-multi-segment": true }, { - "name": "severity", - "description": "If specified, only code scanning alerts with this severity will be returned.", + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", "in": "query", "required": false, "schema": { - "type": "string", - "description": "Severity of a code scanning alert.", - "enum": [ - "critical", - "high", - "medium", - "low", - "warning", - "note", - "error" - ] + "type": "string" } } ], @@ -103140,1239 +103038,170 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "nullable": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "fixed_at": { - "type": "string", - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "dismissed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "dismissed_at": { - "type": "string", - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "dismissed_reason": { - "type": "string", - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "nullable": true, - "enum": [ - "false positive", - "won't fix", - "used in tests" - ] - }, - "dismissed_comment": { - "type": "string", - "description": "The dismissal comment associated with the dismissal of the alert.", - "nullable": true, - "maxLength": 280 - }, - "rule": { - "type": "object", - "properties": { - "id": { - "nullable": true, - "type": "string", - "description": "A unique identifier for the rule used to detect the alert." - }, - "name": { - "type": "string", - "description": "The name of the rule used to detect the alert." - }, - "severity": { - "nullable": true, - "type": "string", - "description": "The severity of the alert.", - "enum": [ - "none", - "note", - "warning", - "error" - ] - }, - "security_severity_level": { - "nullable": true, - "type": "string", - "description": "The security severity of the alert.", - "enum": [ - "low", - "medium", - "high", - "critical" - ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." - }, - "full_description": { - "type": "string", - "description": "A description of the rule used to detect the alert." - }, - "tags": { - "nullable": true, - "type": "array", - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, - "help": { - "nullable": true, - "type": "string", - "description": "Detailed documentation for the rule as GitHub Flavored Markdown." - }, - "help_uri": { - "nullable": true, - "type": "string", - "description": "A link to the documentation for the rule used to detect the alert." - } - } - }, - "tool": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "version": { - "nullable": true, - "type": "string", - "description": "The version of the tool used to generate the code scanning analysis." - }, - "guid": { - "nullable": true, - "type": "string", - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - } - } - }, - "most_recent_instance": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "analysis_key": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." - }, - "environment": { - "type": "string", - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "nullable": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "commit_sha": { - "type": "string" - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "location": { - "type": "object", - "description": "Describe a region within a file for the alert.", - "properties": { - "path": { - "type": "string" - }, - "start_line": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "start_column": { - "type": "integer" - }, - "end_column": { - "type": "integer" - } - } - }, - "html_url": { - "type": "string" - }, - "classifications": { - "type": "array", - "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", - "items": { - "type": "string", - "description": "A classification of the file. For example to identify it as generated.", - "nullable": true, - "enum": [ - "source", - "generated", - "test", - "library" - ] - } - } - } - }, - "repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "bundle": { "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, + "mediaType": { "type": "string" }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true }, - "user_view_type": { - "type": "string", - "example": "public" + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true } }, - "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", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." - }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." - } - }, - "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" - ] - }, - "dismissal_approved_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" + "repository_id": { + "type": "integer" }, - "email": { - "nullable": true, + "bundle_url": { "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true + } } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance", - "repository" - ] + } } }, "examples": { "default": { - "value": [ - { - "number": 4, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", - "html_url": "https://github.com/octocat/hello-world/code-scanning/4", - "state": "open", - "dismissed_by": null, - "dismissed_at": null, - "dismissed_reason": null, - "dismissed_comment": null, - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", - "repository": { - "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}", - "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}", - "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}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" - } - }, - { - "number": 3, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", - "html_url": "https://github.com/octocat/hello-world/code-scanning/3", - "state": "dismissed", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "lib/ab12-gen.js", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } }, - "classifications": [] + "repository_id": 1 }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", - "repository": { - "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 + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } }, - "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}", - "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}", - "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}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + "repository_id": 1 } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "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" - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + ] } } } @@ -104383,22 +103212,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-scanning", - "subcategory": "code-scanning" + "category": "orgs", + "subcategory": "orgs" } } }, - "/orgs/{org}/code-security/configurations": { + "/orgs/{org}/audit-log": { "get": { - "summary": "Get code security configurations for an organization", - "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "Get the audit log for an organization", + "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "operationId": "orgs/get-audit-log", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/get-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization" }, "parameters": [ { @@ -104411,32 +103240,40 @@ } }, { - "name": "target_type", + "name": "phrase", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "include", + "description": "The event types to include:\n\n- `web` - returns web (non-Git) events.\n- `git` - returns Git events.\n- `all` - returns both web and Git events.\n\nThe default is `web`.", "in": "query", - "description": "The target type of the code security configuration", "required": false, "schema": { "type": "string", "enum": [ - "global", + "web", + "git", "all" - ], - "default": "all" + ] } }, { - "name": "per_page", + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", "in": "query", - "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).\"", "required": false, "schema": { - "type": "integer", - "default": 30 + "type": "string" } }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", "in": "query", "required": false, "schema": { @@ -104444,12 +103281,25 @@ } }, { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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).\"", + "name": "order", + "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`.", "in": "query", "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "desc", + "asc" + ] + } + }, + { + "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 } } ], @@ -104462,371 +103312,465 @@ "type": "array", "items": { "type": "object", - "description": "A code security configuration", "properties": { - "id": { + "@timestamp": { "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." }, - "target_type": { + "action": { "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." }, - "description": { - "type": "string", - "description": "A description of the code security configuration" + "active": { + "type": "boolean" }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] + "active_was": { + "type": "boolean" }, - "dependency_graph": { + "actor": { "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The actor who performed the action." }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "actor_id": { + "type": "integer", + "description": "The id of the actor who performed the action." }, - "dependency_graph_autosubmit_action_options": { + "actor_location": { "type": "object", - "description": "Feature options for Automatic dependency submission", "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + "country_name": { + "type": "string" } } }, - "dependabot_alerts": { + "data": { + "type": "object", + "additionalProperties": true + }, + "org_id": { + "type": "integer" + }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, + "blocked_user": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The username of the account being blocked." }, - "dependabot_security_updates": { + "business": { + "type": "string" + }, + "config": { + "type": "array", + "items": { + "type": "object" + } + }, + "config_was": { + "type": "array", + "items": { + "type": "object" + } + }, + "content_type": { + "type": "string" + }, + "operation_type": { + "type": "string" + }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { + "type": "string" + }, + "_document_id": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "A unique identifier for an audit event." }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } + "emoji": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "object" } }, - "code_scanning_default_setup": { + "events_were": { + "type": "array", + "items": { + "type": "object" + } + }, + "explanation": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "hook_id": { + "type": "integer" + }, + "limited_availability": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "old_user": { + "type": "string" + }, + "openssh_public_key": { + "type": "string" + }, + "org": { + "type": "string" + }, + "previous_visibility": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "repo": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The name of the repository." }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", + "repository": { + "type": "string", + "description": "The name of the repository." + }, + "repository_public": { + "type": "boolean" + }, + "target_login": { + "type": "string" + }, + "team": { + "type": "string" + }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { + "type": "string", + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "user": { + "type": "string", + "description": "The user that was affected by the action performed (if available)." + }, + "visibility": { + "type": "string", + "description": "The repository visibility, for example `public` or `private`." + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "@timestamp": 1606929874512, + "action": "team.add_member", + "actor": "octocat", + "created_at": 1606929874512, + "_document_id": "xJJFlFOhQ6b-5vaAFy9Rjw", + "org": "octo-corp", + "team": "octo-corp/example-team", + "user": "monalisa" + }, + { + "@timestamp": 1606507117008, + "action": "org.create", + "actor": "octocat", + "created_at": 1606507117008, + "_document_id": "Vqvg6kZ4MYqwWRKFDzlMoQ", + "org": "octocat-test-org" + }, + { + "@timestamp": 1605719148837, + "action": "repo.destroy", + "actor": "monalisa", + "created_at": 1605719148837, + "_document_id": "LwW2vpJZCDS-WUmo9Z-ifw", + "org": "mona-org", + "repo": "mona-org/mona-test-repo", + "visibility": "private" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/blocks": { + "get": { + "summary": "List users blocked by an organization", + "description": "List the users blocked by an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-blocked-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-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": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } + "type": "string" }, - "code_scanning_delegated_alert_dismissal": { + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "octocat" }, - "secret_scanning": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "MDQ6VXNlcjE=" }, - "secret_scanning_push_protection": { + "avatar_url": { "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "secret_scanning_delegated_bypass": { + "gravatar_id": { "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "secret_scanning_validity_checks": { + "html_url": { "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://github.com/octocat" }, - "secret_scanning_non_provider_patterns": { + "followers_url": { "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "secret_scanning_generic_secrets": { + "following_url": { "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "secret_scanning_delegated_alert_dismissal": { + "gists_url": { "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "private_vulnerability_reporting": { + "starred_url": { "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "enforcement": { + "subscriptions_url": { "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "url": { + "organizations_url": { "type": "string", "format": "uri", - "description": "The URL of the configuration" + "example": "https://api.github.com/users/octocat/orgs" }, - "html_url": { + "repos_url": { "type": "string", "format": "uri", - "description": "The URL of the configuration" + "example": "https://api.github.com/users/octocat/repos" }, - "created_at": { + "events_url": { "type": "string", - "format": "date-time" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "updated_at": { + "received_events_url": { "type": "string", - "format": "date-time" + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] } }, "examples": { "default": { "value": [ { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_delagated_alert_dismissal": "enabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "enabled", - "secret_scanning_delegated_bypass_options": { - "reviewers": [ - { - "security_configuration_id": 17, - "reviewer_id": 5678, - "reviewer_type": "TEAM" - } - ] - }, - "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "secret_scanning_delegated_alert_dismissal": "not_set", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - }, - { - "id": 1326, - "target_type": "organization", - "name": "High risk settings", - "description": "This is a code security configuration for octo-org high risk repositories", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "enabled", - "code_scanning_default_setup": "enabled", - "code_scanning_delagated_alert_dismissal": "enabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", - "created_at": "2024-05-10T00:00:00Z", - "updated_at": "2024-05-10T00:00:00Z" + "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 } ] } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + } + }, + "/orgs/{org}/blocks/{username}": { + "get": { + "summary": "Check if a user is blocked by an organization", + "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-blocked-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "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" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "If the user is blocked" + }, + "404": { + "description": "If the user is not blocked", "content": { "application/json": { "schema": { @@ -104855,20 +103799,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" } }, - "post": { - "summary": "Create a code security configuration", - "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "put": { + "summary": "Block a user from an organization", + "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/create-configuration", + "operationId": "orgs/block-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization" }, "parameters": [ { @@ -104879,605 +103823,84 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "description": { - "type": "string", - "description": "A description of the code security configuration", - "maxLength": 255 - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ], - "default": "disabled" - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "enabled" - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", - "default": false - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "code_scanning_options": { - "type": "object", - "description": "Security Configuration feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "not_set" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ], - "default": "enforced" - } - }, - "required": [ - "name", - "description" - ] - }, - "examples": { - "default": { - "summary": "Example for a code security configuration", - "value": { - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "secret_scanning": "enabled" - } - } - } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { - "201": { - "description": "Successfully created code security configuration", + "204": { + "description": "Response" + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { + "title": "Validation Error", + "description": "Validation Error", "type": "object", - "description": "A code security configuration", + "required": [ + "message", + "documentation_url" + ], "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "message": { + "type": "string" }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "documentation_url": { + "type": "string" }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { + "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", + "nullable": true + }, + { "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "nullable": true }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } } - } + ] } } } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "examples": { - "default": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" } } } @@ -105488,22 +103911,71 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "orgs", + "subcategory": "blocking" + } + }, + "delete": { + "summary": "Unblock a user from an organization", + "description": "Unblocks the given user on behalf of the specified organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/unblock-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" } } }, - "/orgs/{org}/code-security/configurations/defaults": { + "/orgs/{org}/bypass-requests/push-rules": { "get": { - "summary": "Get default code security configurations", - "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "List push rule bypass requests within an organization", + "description": "Lists the requests made by users of a repository to bypass push protection rules within an organization.", "tags": [ - "code-security" + "orgs" ], - "operationId": "code-security/get-default-configurations", + "operationId": "orgs/list-push-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "bypass-requests" }, "parameters": [ { @@ -105514,6 +103986,86 @@ "schema": { "type": "string" } + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + { + "name": "request_status", + "description": "The status of the bypass request to filter on. When specified, only requests with this status will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "deleted", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "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": { @@ -105523,281 +104075,188 @@ "application/json": { "schema": { "type": "array", - "description": "A list of default code security configurations", "items": { + "title": "Push rule bypass request", + "description": "A bypass request made by a user asking to be exempted from a push rule in this repository.", "type": "object", "properties": { - "default_for_new_repos": { - "enum": [ - "public", - "private_and_internal", - "all" - ], - "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + "id": { + "type": "integer", + "description": "The unique identifier of the bypass request." }, - "configuration": { + "number": { + "type": "integer", + "description": "The number uniquely identifying the bypass request within its repository." + }, + "repository": { "type": "object", - "description": "A code security configuration", + "description": "The repository the bypass request is for.", "properties": { "id": { "type": "integer", - "description": "The ID of the code security configuration" + "description": "The ID of the repository the bypass request is for.", + "nullable": true }, "name": { "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } + "description": "The name of the repository the bypass request is for.", + "nullable": true }, - "dependabot_alerts": { + "full_name": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The full name of the repository the bypass request is for.", + "nullable": true + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization.", + "nullable": true }, - "dependabot_security_updates": { + "name": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } + "description": "The name of the organization.", + "nullable": true + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the bypass.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the bypass." }, - "code_scanning_default_setup": { + "actor_name": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } + "description": "The name of the GitHub user who requested the bypass." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "nullable": true, + "type": "array", + "description": "Data describing the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated." + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated." + }, + "total_violations": { + "type": "integer", + "description": "The number of rule violations generated from the push associated with this request." + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated." } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "status": { + "type": "string", + "description": "The status of the bypass request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "completed", + "expired", + "deleted", + "open" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the bypass request.", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the bypass request.", + "nullable": true, + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." } } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" } } + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1" + }, + "html_url": { + "type": "string", + "description": "The URL to view the bypass request in a browser.", + "format": "uri", + "example": "https://github.com/octo-org/smile/exemptions/1" } } } @@ -105806,84 +104265,92 @@ "default": { "value": [ { - "default_for_new_repos": "public", - "configuration": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "enabled", - "secret_scanning_delegated_bypass_options": { - "reviewers": [ - { - "security_configuration_id": 1325, - "reviewer_id": 5678, - "reviewer_type": "TEAM" - } - ] - }, - "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "push_ruleset_bypass", + "data": [ + { + "ruleset_id": 410, + "ruleset_name": "Exclude image files", + "total_violations": 1, + "rule_type": "file_extension_restriction" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", + "status": "denied", + "requester_comment": "Updating site images to follow changes in marketing. Part 1", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1", + "html_url": "https://github.com/octo-org/smile/exemptions/1" }, { - "default_for_new_repos": "private_and_internal", - "configuration": { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - } + "id": 12, + "number": 24, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "push_ruleset_bypass", + "data": [ + { + "ruleset_id": 410, + "ruleset_name": "Exclude image files", + "total_violations": 1, + "rule_type": "file_extension_restriction" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", + "status": "denied", + "requester_comment": "Updating site images to follow changes in marketing. Part 2", + "expires_at": "2024-07-08T07:43:03Z", + "created_at": "2024-07-01T07:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2", + "html_url": "https://github.com/octo-org/smile/exemptions/2" } ] } @@ -105891,11 +104358,8 @@ } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -105920,8 +104384,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -105946,26 +104410,26 @@ } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" } } }, - "/orgs/{org}/code-security/configurations/detach": { - "delete": { - "summary": "Detach configurations from repositories", - "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "/orgs/{org}/bypass-requests/secret-scanning": { + "get": { + "summary": "List bypass requests for secret scanning for an org", + "description": "List requests to bypass secret scanning push protection in an org.\n\nDelegated bypass must be enabled on repositories in the org and the user must be a bypass reviewer to access this endpoint.\nPersonal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "secret-scanning" ], - "operationId": "code-security/detach-configuration", + "operationId": "secret-scanning/list-org-bypass-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/delegated-bypass#list-bypass-requests-for-secret-scanning-for-an-org" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "delegated-bypass" }, "parameters": [ { @@ -105976,127 +104440,372 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", - "minItems": 1, - "maxItems": 1000, - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } - } - } - }, - "examples": { - "default": { - "summary": "Example for detaching repositories from configurations.", - "value": { - "selected_repository_ids": [ - 32, - 91 - ] - } - } - } + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + { + "name": "request_status", + "description": "The status of the bypass request to filter on. When specified, only requests with this status will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "approved", + "expired", + "deleted", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "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": { - "204": { - "description": "A header with no content is returned." - }, - "400": { - "description": "Bad Request", + "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" - } - } - } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" + "type": "array", + "items": { + "title": "Secret scanning bypass request", + "description": "A bypass request made by a user asking to be exempted from push protection in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the bypass request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the bypass request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the bypass request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the bypass request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the bypass request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the bypass.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the bypass." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the bypass." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "nullable": true, + "type": "array", + "description": "Data describing the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "bypass_reason": { + "type": "string", + "enum": [ + "used_in_tests", + "false_positive", + "fix_later" + ], + "description": "The reason the bypass was requested." + }, + "path": { + "type": "string", + "description": "The path in the repo where the secret was located during the request." + }, + "branch": { + "type": "string", + "description": "The branch in the repo where the secret was located during the request." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "status": { + "type": "string", + "description": "The status of the bypass request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "completed", + "expired", + "open" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the bypass request.", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the bypass request.", + "nullable": true, + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1" + }, + "html_url": { + "type": "string", + "description": "The URL to view the bypass request in a browser.", + "format": "uri", + "example": "https://github.com/octo-org/smile/exemptions/1" } } } - } - } - } - }, - "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": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning", + "data": [ + { + "secret_type": "adafruit_io_key", + "bypass_reason": "used_in_tests", + "path": "/tests/README.md:16:0", + "branch": "refs/heads/main" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1", + "html_url": "https://github.com/octo-org/smile/exemptions/1" + }, + { + "id": 12, + "number": 24, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning", + "data": [ + { + "secret_type": "adafruit_io_key", + "bypass_reason": "fix_later", + "path": "README.md:17:0", + "branch": "refs/heads/my-branch" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", + "status": "denied", + "requester_comment": "Token is already revoked, I'll remove it later", + "expires_at": "2024-07-08T07:43:03Z", + "created_at": "2024-07-01T07:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/2", + "html_url": "https://github.com/octo-org/smile/exemptions/2" + } + ] } } } @@ -106128,8 +104837,8 @@ } } }, - "409": { - "description": "Conflict", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -106154,26 +104863,20 @@ } } } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" } } }, - "/orgs/{org}/code-security/configurations/{configuration_id}": { + "/orgs/{org}/campaigns": { "get": { - "summary": "Get a code security configuration", - "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "summary": "List campaigns for an organization", + "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/get-configuration", + "operationId": "campaigns/list-org-campaigns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization" }, "parameters": [ { @@ -106186,12 +104889,66 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, + "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" + "type": "integer", + "default": 1 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "state", + "description": "If specified, only campaigns with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "ends_at", + "published" + ], + "default": "created" } } ], @@ -106201,317 +104958,488 @@ "content": { "application/json": { "schema": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + "type": "array", + "items": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The number of the newly created campaign" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "name": { + "type": "string", + "description": "The campaign name" + }, + "description": { + "type": "string", + "description": "The campaign description" + }, + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", + "nullable": true + }, + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "contact_link": { + "description": "The contact link of the campaign.", + "type": "string", + "format": "uri", + "nullable": true + }, + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] } }, "examples": { "default": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false + "value": [ + { + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open" }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" - } + { + "number": 4, + "created_at": "2024-03-30T12:29:18Z", + "updated_at": "2024-03-30T12:29:18Z", + "name": "Mitre top 10 KEV", + "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.", + "managers": [ + { + "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 + } + ], + "ends_at": "2024-04-30T12:29:18Z", + "closed_at": null, + "state": "open" + } + ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -106536,25 +105464,20 @@ } } }, - "404": { - "description": "Resource not found", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -106566,20 +105489,20 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } }, - "patch": { - "summary": "Update a code security configuration", - "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "post": { + "summary": "Create a campaign for an organization", + "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/update-configuration", + "operationId": "campaigns/create-campaign", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization" }, "parameters": [ { @@ -106590,15 +105513,6 @@ "schema": { "type": "string" } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -106610,248 +105524,104 @@ "additionalProperties": false, "properties": { "name": { + "description": "The name of the campaign", "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." + "minLength": 1, + "maxLength": 50 }, "description": { + "description": "A description for the campaign", "type": "string", - "description": "A description of the code security configuration", + "minLength": 1, "maxLength": 255 }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "code_security": { - "type": "string", - "description": "The enablement status of GitHub Code Security features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } + "managers": { + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The login of each manager", + "type": "string" } }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." - } + "team_managers": { + "description": "The slugs of the teams to set as the campaign managers.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The slug of each team", + "type": "string" } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ], - "default": "disabled" - }, - "secret_protection": { - "type": "string", - "description": "The enablement status of GitHub Secret Protection features.", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { + "ends_at": { + "description": "The end date and time of the campaign. The date must be in the future.", "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "secret_scanning_delegated_bypass": { + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "uri", + "nullable": true }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } + "code_scanning_alerts": { + "description": "The code scanning alerts to include in this campaign", + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "repository_id": { + "type": "integer", + "description": "The repository id" + }, + "alert_numbers": { + "type": "array", + "description": "The alert numbers", + "minItems": 1, + "items": { + "type": "integer" } } - } + }, + "required": [ + "repository_id", + "alert_numbers" + ] } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] + "generate_issues": { + "description": "If true, will automatically generate issues for the campaign. The default is false.", + "type": "boolean", + "default": false } - } + }, + "required": [ + "name", + "description", + "ends_at", + "code_scanning_alerts" + ] }, "examples": { "default": { - "summary": "Example for updating a code security configuration", "value": { - "name": "octo-org recommended settings v2", - "secret_scanning": "disabled", - "code_scanning_default_setup": "enabled" + "name": "Critical CodeQL alerts", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + "octocat" + ], + "ends_at": "2024-03-14T00:00:00Z", + "code_scanning_alerts": [ + { + "repository_id": 1296269, + "alert_numbers": [ + 1, + 2 + ] + } + ] } } } @@ -106860,362 +105630,451 @@ }, "responses": { "200": { - "description": "Response when a configuration is updated", + "description": "Response", "content": { "application/json": { "schema": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", - "description": "A code security configuration", "properties": { - "id": { + "number": { "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The number of the newly created campaign" }, - "dependency_graph_autosubmit_action": { + "created_at": { "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependabot_alerts": { + "updated_at": { "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "dependabot_security_updates": { + "name": { "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } - } + "description": "The campaign name" }, - "code_scanning_default_setup": { + "description": { "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "description": "The campaign description" }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } + "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" + ] } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, "required": [ - "reviewer_id", - "reviewer_type" - ], + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", "properties": { - "reviewer_id": { + "id": { + "description": "Unique identifier of the team", "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" + "example": 1 }, - "reviewer_type": { + "node_id": { "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } - } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "secret_scanning_delegated_alert_dismissal": { + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time" }, - "private_vulnerability_reporting": { + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "format": "date-time", + "nullable": true }, - "enforcement": { + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", "type": "string", - "description": "The enforcement status for a security configuration", "enum": [ - "enforced", - "unenforced" + "open", + "closed" ] }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { + "contact_link": { + "description": "The contact link of the campaign.", "type": "string", "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { - "type": "string", - "format": "date-time" + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } - } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] }, "examples": { "default": { "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings v2", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "disabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 + } } } } } } }, - "204": { - "description": "Response when no new updates are made" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" - } - }, - "delete": { - "summary": "Delete a code security configuration", - "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/delete-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "A header with no content is returned." - }, "400": { "description": "Bad Request", "content": { @@ -107239,45 +106098,11 @@ } } } - }, - "application/scim+json": { - "schema": { - "title": "Scim Error", - "description": "Scim Error", - "type": "object", - "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -107302,8 +106127,8 @@ } } }, - "404": { - "description": "Resource not found", + "422": { + "description": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -107328,25 +106153,23 @@ } } }, - "409": { - "description": "Conflict", + "429": { + "description": "Too Many Requests" + }, + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { + "code": { "type": "string" }, - "url": { + "message": { "type": "string" }, - "status": { + "documentation_url": { "type": "string" } } @@ -107358,126 +106181,22 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" - } - } - }, - "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { - "post": { - "summary": "Attach a configuration to repositories", - "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", - "tags": [ - "code-security" - ], - "operationId": "code-security/attach-configuration", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false, - "properties": { - "scope": { - "type": "string", - "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", - "enum": [ - "all", - "all_without_configurations", - "public", - "private_or_internal", - "selected" - ] - }, - "selected_repository_ids": { - "type": "array", - "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", - "items": { - "type": "integer", - "description": "Unique identifier of the repository." - } - } - }, - "required": [ - "scope" - ] - }, - "examples": { - "default": { - "summary": "Example for attaching a configuration to some repositories", - "value": { - "scope": "selected", - "selected_repository_ids": [ - 32, - 91 - ] - } - } - } - } - } - }, - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "default": { - "value": null - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } } }, - "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { - "put": { - "summary": "Set a code security configuration as a default for an organization", - "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "/orgs/{org}/campaigns/{campaign_number}": { + "get": { + "summary": "Get a campaign for an organization", + "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", "tags": [ - "code-security" + "campaigns" ], - "operationId": "code-security/set-configuration-as-default", + "operationId": "campaigns/get-campaign-summary", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization" }, "parameters": [ { @@ -107490,8 +106209,8 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", + "name": "campaign_number", + "description": "The campaign number.", "in": "path", "required": true, "schema": { @@ -107499,361 +106218,1074 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "default_for_new_repos": { - "type": "string", - "description": "Specify which types of repository this security configuration should be applied to by default.", - "enum": [ - "all", - "none", - "private_and_internal", - "public" - ] - } - } - }, - "examples": { - "default": { - "summary": "Set this configuration to be enabled by default on all new repositories.", - "value": { - "default_for_new_repos": "all" - } - } - } - } - } - }, "responses": { "200": { - "description": "Default successfully changed.", + "description": "Response", "content": { "application/json": { "schema": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", "type": "object", "properties": { - "default_for_new_repos": { + "number": { + "type": "integer", + "description": "The number of the newly created campaign" + }, + "created_at": { "type": "string", - "description": "Specifies which types of repository this security configuration is applied to by default.", - "enum": [ - "all", - "none", - "private_and_internal", - "public" - ] + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." }, - "configuration": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": "object", - "description": "Feature options for code scanning", - "nullable": true, - "properties": { - "allow_advanced": { - "nullable": true, - "type": "boolean", - "description": "Whether to allow repos which use advanced setup" - } + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "name": { + "type": "string", + "description": "The campaign name" + }, + "description": { + "type": "string", + "description": "The campaign description" + }, + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": "object", - "description": "Feature options for code scanning default setup", - "nullable": true, - "properties": { - "runner_type": { - "nullable": true, - "type": "string", - "enum": [ - "standard", - "labeled", - "not_set" - ], - "description": "Whether to use labeled runners or standard GitHub runners." + "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" + ] + } + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } }, - "runner_label": { - "nullable": true, - "type": "string", - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", + "nullable": true + }, + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "contact_link": { + "description": "The contact link of the campaign.", + "type": "string", + "format": "uri", + "nullable": true + }, + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] + } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] + }, + "examples": { + "default": { + "value": { + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 + } + } + } + } + } + } + }, + "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": "Unprocessable Entity", + "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": "campaigns", + "subcategory": "campaigns" + } + }, + "patch": { + "summary": "Update a campaign", + "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/update-campaign", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "campaign_number", + "description": "The campaign number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "description": "The name of the campaign", + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "description": "A description for the campaign", + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "managers": { + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + } + }, + "team_managers": { + "description": "The slugs of the teams to set as the campaign managers.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The slug of each team", + "type": "string" + } + }, + "ends_at": { + "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", + "type": "string", + "format": "uri", + "nullable": true + }, + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + } + } + }, + "examples": { + "default": { + "value": { + "name": "Critical CodeQL alerts" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The number of the newly created campaign" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "name": { + "type": "string", + "description": "The campaign name" + }, + "description": { + "type": "string", + "description": "The campaign description" + }, + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } + "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" + ] + } + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" } - } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true } }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", + "nullable": true + }, + "state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "contact_link": { + "description": "The contact link of the campaign.", + "type": "string", + "format": "uri", + "nullable": true + }, + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" }, - "created_at": { - "type": "string", - "format": "date-time" + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" }, - "updated_at": { - "type": "string", - "format": "date-time" + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" } - } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] } - } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] }, "examples": { "default": { "value": { - "default_for_new_repos": "all", - "configuration": { - "value": { - "id": 1325, - "target_type": "organization", - "name": "octo-org recommended settings", - "description": "This is a code security configuration for octo-org", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "disabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "code_scanning_options": { - "allow_advanced": false - }, - "code_scanning_delegated_alert_dismissal": "disabled", - "secret_scanning": "enabled", - "secret_scanning_push_protection": "disabled", - "secret_scanning_delegated_bypass": "disabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "secret_scanning_generic_secrets": "disabled", - "secret_scanning_delegated_alert_dismissal": "disabled", - "private_vulnerability_reporting": "disabled", - "enforcement": "enforced", - "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", - "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", - "created_at": "2024-05-01T00:00:00Z", - "updated_at": "2024-05-01T00:00:00Z" + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "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 } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 } } } @@ -107861,8 +107293,60 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", + "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": "Unprocessable Entity", "content": { "application/json": { "schema": { @@ -107887,6 +107371,70 @@ } } }, + "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": "campaigns", + "subcategory": "campaigns" + } + }, + "delete": { + "summary": "Delete a campaign for an organization", + "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/delete-campaign", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "campaign_number", + "description": "The campaign number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Deletion successful" + }, "404": { "description": "Resource not found", "content": { @@ -107912,27 +107460,48 @@ } } } + }, + "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": "code-security", - "subcategory": "configurations" + "category": "campaigns", + "subcategory": "campaigns" } } }, - "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + "/orgs/{org}/code-scanning/alerts": { "get": { - "summary": "Get repositories associated with a code security configuration", - "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "summary": "List code scanning alerts for an organization", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ - "code-security" + "code-scanning" ], - "operationId": "code-security/get-repositories-for-configuration", + "operationId": "code-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -107945,22 +107514,24 @@ } }, { - "name": "configuration_id", - "description": "The unique identifier of the code security configuration.", - "in": "path", - "required": true, + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." } }, { - "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).\"", + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", "in": "query", "required": false, "schema": { - "type": "integer", - "default": 30 + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } }, { @@ -107982,13 +107553,84 @@ } }, { - "name": "status", - "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "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 + } + }, + { + "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": "direction", + "description": "The direction to sort the results by.", "in": "query", "required": false, "schema": { "type": "string", - "default": "all" + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "state", + "description": "If specified, only code scanning alerts with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "severity", + "description": "If specified, only code scanning alerts with this severity will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "Severity of a code scanning alert.", + "enum": [ + "critical", + "high", + "medium", + "low", + "warning", + "note", + "error" + ] } } ], @@ -108001,22 +107643,369 @@ "type": "array", "items": { "type": "object", - "description": "Repositories associated with a code security configuration and attachment status", "properties": { - "status": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { "type": "string", - "description": "The attachment status of the code security configuration on the repository.", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "nullable": true, "enum": [ - "attached", - "attaching", - "detached", - "removed", - "enforced", - "failed", - "updating", - "removed_by_enterprise" + "open", + "dismissed", + "fixed" + ] + }, + "fixed_at": { + "type": "string", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "dismissed_at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests" ] }, + "dismissed_comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "security_severity_level": { + "nullable": true, + "type": "string", + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "A description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "help": { + "nullable": true, + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "nullable": true, + "type": "string", + "description": "A link to the documentation for the rule used to detect the alert." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "category": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "nullable": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + } + } + } + }, "repository": { "title": "Simple Repository", "description": "A GitHub repository.", @@ -108435,87 +108424,874 @@ "trees_url", "url" ] + }, + "dismissal_approved_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true } - } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance", + "repository" + ] } }, "examples": { "default": { - "summary": "Example of code security configuration repositories", "value": [ { - "status": "attached", + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "dismissed_comment": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", "repository": { - "value": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "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}", + "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}", + "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}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", + "repository": { + "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}", + "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}", + "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}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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" + } + } + } + } + } + }, + "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": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/orgs/{org}/code-security/configurations": { + "get": { + "summary": "Get code security configurations for an organization", + "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configurations-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "target_type", + "in": "query", + "description": "The target type of the code security configuration", + "required": false, + "schema": { + "type": "string", + "enum": [ + "global", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "in": "query", + "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).\"", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } } } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_delagated_alert_dismissal": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 17, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] + }, + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "secret_scanning_delegated_alert_dismissal": "not_set", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "organization", + "name": "High risk settings", + "description": "This is a code security configuration for octo-org high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "code_scanning_delagated_alert_dismissal": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" } ] } @@ -108582,39 +109358,654 @@ "category": "code-security", "subcategory": "configurations" } - } - }, - "/orgs/{org}/codespaces": { - "get": { - "summary": "List codespaces for the organization", - "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "post": { + "summary": "Create a code security configuration", + "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-in-organization", + "operationId": "code-security/create-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-the-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration" }, "parameters": [ { - "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", + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" } - }, - { - "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 + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ], + "default": "disabled" + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", + "default": false + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_options": { + "type": "object", + "description": "Security Configuration feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "not_set" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] + }, + "examples": { + "default": { + "summary": "Example for a code security configuration", + "value": { + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" + } + } + } } - }, + } + }, + "responses": { + "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations", + "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations" + }, + "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -108631,1695 +110022,370 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "codespaces" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "codespaces": { - "type": "array", - "items": { + "type": "array", + "description": "A list of default code security configurations", + "items": { + "type": "object", + "properties": { + "default_for_new_repos": { + "enum": [ + "public", + "private_and_internal", + "all" + ], + "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + }, + "configuration": { "type": "object", - "title": "Codespace", - "description": "A codespace.", + "description": "A code security configuration", "properties": { "id": { "type": "integer", - "format": "int64", - "example": 1 + "description": "The ID of the code security configuration" }, "name": { - "description": "Automatically generated name of this codespace.", "type": "string", - "example": "monalisa-octocat-hello-world-g4wpq6h95q" + "description": "The name of the code security configuration. Must be unique within the organization." }, - "display_name": { - "description": "Display name for this codespace.", + "target_type": { "type": "string", - "example": "bookish space pancake", - "nullable": true + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "environment_id": { - "description": "UUID identifying this codespace's environment.", + "description": { "type": "string", - "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "nullable": true + "description": "A description of the code security configuration" }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { "type": "object", + "description": "Feature options for Automatic dependency submission", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } - }, - "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" + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" ] }, - "billable_owner": { - "title": "Simple User", - "description": "A GitHub user.", + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { "type": "object", + "description": "Feature options for code scanning", + "nullable": true, "properties": { - "name": { + "allow_advanced": { "nullable": true, - "type": "string" - }, - "email": { + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." }, - "user_view_type": { + "runner_label": { + "nullable": true, "type": "string", - "example": "public" + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } - }, - "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" + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" ] }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { "type": "object", + "description": "Feature options for secret scanning delegated bypass", "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" - }, - "name": { - "type": "string", - "example": "Contributor Covenant" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" - }, - "body": { - "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "security_and_analysis": { - "nullable": true, - "type": "object", - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_validity_checks": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } } } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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" - ] - }, - "machine": { - "type": "object", - "title": "Codespace machine", - "description": "A description of the machine powering a codespace.", - "properties": { - "name": { - "type": "string", - "description": "The name of the machine.", - "example": "standardLinux" - }, - "display_name": { - "type": "string", - "description": "The display name of the machine includes cores, memory, and storage.", - "example": "4 cores, 16 GB RAM, 64 GB storage" - }, - "operating_system": { - "type": "string", - "description": "The operating system of the machine.", - "example": "linux" - }, - "storage_in_bytes": { - "type": "integer", - "description": "How much storage is available to the codespace.", - "example": 68719476736 - }, - "memory_in_bytes": { - "type": "integer", - "description": "How much memory is available to the codespace.", - "example": 17179869184 - }, - "cpus": { - "type": "integer", - "description": "How many cores are available to the codespace.", - "example": 4 - }, - "prebuild_availability": { - "type": "string", - "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", - "example": "ready", - "enum": [ - "none", - "ready", - "in_progress" - ], - "nullable": true } - }, - "required": [ - "name", - "display_name", - "operating_system", - "storage_in_bytes", - "memory_in_bytes", - "cpus", - "prebuild_availability" - ], - "nullable": true - }, - "devcontainer_path": { - "description": "Path to devcontainer.json from repo root used to create Codespace.", - "type": "string", - "example": ".devcontainer/example/devcontainer.json", - "nullable": true - }, - "prebuild": { - "description": "Whether the codespace was created from a prebuild.", - "type": "boolean", - "example": false, - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" + } }, - "last_used_at": { - "description": "Last known time this codespace was started.", + "secret_scanning_validity_checks": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "state": { - "description": "State of this codespace.", + "description": "The enablement status of secret scanning validity checks", "enum": [ - "Unknown", - "Created", - "Queued", - "Provisioning", - "Available", - "Awaiting", - "Unavailable", - "Deleted", - "Moved", - "Shutdown", - "Archived", - "Starting", - "ShuttingDown", - "Failed", - "Exporting", - "Updating", - "Rebuilding" - ], - "example": "Available", - "type": "string" + "enabled", + "disabled", + "not_set" + ] }, - "url": { - "description": "API URL for this codespace.", + "secret_scanning_non_provider_patterns": { "type": "string", - "format": "uri" - }, - "git_status": { - "description": "Details about the codespace's git repository.", - "type": "object", - "properties": { - "ahead": { - "description": "The number of commits the local repository is ahead of the remote.", - "type": "integer", - "example": 0 - }, - "behind": { - "description": "The number of commits the local repository is behind the remote.", - "type": "integer", - "example": 0 - }, - "has_unpushed_changes": { - "description": "Whether the local repository has unpushed changes.", - "type": "boolean" - }, - "has_uncommitted_changes": { - "description": "Whether the local repository has uncommitted changes.", - "type": "boolean" - }, - "ref": { - "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", - "type": "string", - "example": "main" - } - } - }, - "location": { - "description": "The initally assigned location of a new codespace.", + "description": "The enablement status of secret scanning non-provider patterns", "enum": [ - "EastUs", - "SouthEastAsia", - "WestEurope", - "WestUs2" - ], - "example": "WestUs2", - "type": "string" - }, - "idle_timeout_minutes": { - "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", - "type": "integer", - "example": 60, - "nullable": true + "enabled", + "disabled", + "not_set" + ] }, - "web_url": { - "description": "URL to access this codespace on the web.", + "secret_scanning_generic_secrets": { "type": "string", - "format": "uri" + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "machines_url": { - "description": "API URL to access available alternate machine types for this codespace.", + "secret_scanning_delegated_alert_dismissal": { "type": "string", - "format": "uri" + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "start_url": { - "description": "API URL to start this codespace.", + "private_vulnerability_reporting": { "type": "string", - "format": "uri" + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "stop_url": { - "description": "API URL to stop this codespace.", + "enforcement": { "type": "string", - "format": "uri" + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] }, - "publish_url": { - "description": "API URL to publish this codespace to a new repository.", + "url": { "type": "string", "format": "uri", - "nullable": true + "description": "The URL of the configuration" }, - "pulls_url": { - "description": "API URL for the Pull Request associated with this codespace, if any.", + "html_url": { "type": "string", "format": "uri", - "nullable": true - }, - "recent_folders": { - "type": "array", - "items": { - "type": "string" - } - }, - "runtime_constraints": { - "type": "object", - "properties": { - "allowed_port_privacy_settings": { - "description": "The privacy settings a user can select from when forwarding a port.", - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - } - } - }, - "pending_operation": { - "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", - "type": "boolean", - "nullable": true - }, - "pending_operation_disabled_reason": { - "description": "Text to show user when codespace is disabled by a pending operation", - "type": "string", - "nullable": true - }, - "idle_timeout_notice": { - "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", - "type": "string", - "nullable": true - }, - "retention_period_minutes": { - "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", - "type": "integer", - "example": 60, - "nullable": true + "description": "The URL of the configuration" }, - "retention_expires_at": { - "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "created_at": { "type": "string", - "format": "date-time", - "example": "2011-01-26T20:01:12Z", - "nullable": true + "format": "date-time" }, - "last_known_stop_notice": { - "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "updated_at": { "type": "string", - "example": "you've used 100% of your spending limit for Codespaces", - "nullable": true + "format": "date-time" } - }, - "required": [ - "id", - "name", - "environment_id", - "owner", - "billable_owner", - "repository", - "machine", - "prebuild", - "created_at", - "updated_at", - "last_used_at", - "state", - "url", - "git_status", - "location", - "idle_timeout_minutes", - "web_url", - "machines_url", - "start_url", - "stop_url", - "pulls_url", - "recent_folders" - ] + } } } } }, "examples": { "default": { - "value": { - "total_count": 3, - "codespaces": [ - { - "id": 1, - "name": "monalisa-octocat-hello-world-g4wpq6h95q", - "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", - "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 - }, - "billable_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 - }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 - }, - "prebuild": false, - "devcontainer_path": ".devcontainer/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" - }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", - "recent_folders": [] - }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-3f89ada1j3", - "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", - "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 - }, - "billable_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 - }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 + "value": [ + { + "default_for_new_repos": "public", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false }, - "prebuild": false, - "devcontainer_path": ".devcontainer/foobar/devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", - "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": [] - }, - { - "id": 1, - "name": "monalisa-octocat-hello-world-f8adfad99a", - "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", - "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 + "code_scanning_options": { + "allow_advanced": false }, - "billable_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 + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 1325, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] }, - "repository": { - "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + { + "default_for_new_repos": "private_and_internal", + "configuration": { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false }, - "machine": { - "name": "standardLinux", - "display_name": "4 cores, 16 GB RAM, 64 GB storage", - "operating_system": "linux", - "storage_in_bytes": 68719476736, - "memory_in_bytes": 17179869184, - "cpus": 4 + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null }, - "prebuild": false, - "devcontainer_path": ".devcontainer.json", - "created_at": "2021-10-14T00:53:30-06:00", - "updated_at": "2021-10-14T00:53:32-06:00", - "last_used_at": "2021-10-14T00:53:30-06:00", - "state": "Available", - "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", - "git_status": { - "ahead": 0, - "behind": 0, - "has_unpushed_changes": false, - "has_uncommitted_changes": false, - "ref": "main" + "code_scanning_options": { + "allow_advanced": false }, - "location": "WestUs2", - "idle_timeout_minutes": 60, - "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", - "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", - "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", - "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", - "recent_folders": [] + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" } - ] - } + } + ] } } } @@ -110328,58 +110394,6 @@ "304": { "description": "Not modified" }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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": { @@ -110435,23 +110449,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/codespaces/access": { - "put": { - "summary": "Manage access control for organization codespaces", - "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "/orgs/{org}/code-security/configurations/detach": { + "delete": { + "summary": "Detach configurations from repositories", + "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/set-codespaces-access", + "operationId": "code-security/detach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories" }, "parameters": [ { @@ -110464,44 +110478,33 @@ } } ], - "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", + "additionalProperties": false, "properties": { - "visibility": { - "type": "string", - "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.", - "enum": [ - "disabled", - "selected_members", - "all_members", - "all_members_and_outside_collaborators" - ] - }, - "selected_usernames": { + "selected_repository_ids": { "type": "array", - "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.", + "description": "An array of repository IDs to detach from configurations. Up to 1000 IDs can be provided.", + "minItems": 1, + "maxItems": 1000, "items": { - "type": "string" - }, - "maxItems": 100 + "type": "integer", + "description": "Unique identifier of the repository." + } } - }, - "required": [ - "visibility" - ] + } }, "examples": { "default": { + "summary": "Example for detaching repositories from configurations.", "value": { - "visibility": "selected_members", - "selected_usernames": [ - "johnDoe", - "atomIO" + "selected_repository_ids": [ + 32, + 91 ] } } @@ -110511,16 +110514,10 @@ }, "responses": { "204": { - "description": "Response when successfully modifying permissions." - }, - "304": { - "description": "Not modified" + "description": "A header with no content is returned." }, "400": { - "description": "Users are neither members nor collaborators of this organization." - }, - "404": { - "description": "Resource not found", + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -110542,71 +110539,36 @@ } } } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Scim Error", + "description": "Scim Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { - "type": "string" + "type": "string", + "nullable": true }, "documentation_url": { - "type": "string" + "type": "string", + "nullable": true }, - "errors": { + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + "type": "string" } } } @@ -110614,8 +110576,8 @@ } } }, - "500": { - "description": "Internal Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -110639,82 +110601,6 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" - } - } - }, - "/orgs/{org}/codespaces/access/selected_users": { - "post": { - "summary": "Add users to Codespaces access for an organization", - "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/set-codespaces-access-users", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "deprecated": true, - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members whose codespaces be billed to the organization.", - "items": { - "type": "string" - }, - "maxItems": 100 - } - }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "johnDoe", - "atomIO" - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response when successfully modifying permissions." - }, - "304": { - "description": "Not modified" - }, - "400": { - "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", @@ -110742,77 +110628,8 @@ } } }, - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Internal Error", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -110840,23 +110657,24 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - }, - "delete": { - "summary": "Remove users from Codespaces access for an organization", - "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}": { + "get": { + "summary": "Get a code security configuration", + "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/delete-codespaces-access-users", + "operationId": "code-security/get-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration" }, - "deprecated": true, "parameters": [ { "name": "org", @@ -110866,53 +110684,334 @@ "schema": { "type": "string" } + }, + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_usernames": { - "type": "array", - "description": "The usernames of the organization members whose codespaces should not be billed to the organization.", - "items": { - "type": "string" + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" }, - "maxItems": 100 + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } } }, - "required": [ - "selected_usernames" - ] - }, - "examples": { - "default": { - "value": { - "selected_usernames": [ - "johnDoe", - "atomIO" - ] + "examples": { + "default": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } } } } } - } - }, - "responses": { - "204": { - "description": "Response when successfully modifying permissions." }, "304": { "description": "Not modified" }, - "400": { - "description": "Users are neither members nor collaborators of this organization." - }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -110937,18 +111036,14 @@ } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -110956,76 +111051,11 @@ "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "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" + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -111035,23 +111065,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organizations" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - } - }, - "/orgs/{org}/codespaces/secrets": { - "get": { - "summary": "List organization secrets", - "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-org-secrets", + "operationId": "code-security/update-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" }, "parameters": [ { @@ -111064,224 +111092,605 @@ } }, { - "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", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "secrets" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "secrets": { - "type": "array", - "items": { - "title": "Codespaces Secret", - "description": "Secrets for a GitHub Codespace.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret", - "example": "SECRET_NAME", - "type": "string" - }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", - "type": "string", - "format": "date-time" - }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" - }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" - } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } - } - }, - "examples": { - "default": { - "value": { - "total_count": 2, - "secrets": [ - { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" - }, - { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z", - "visibility": "all" + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } } - ] + } } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] } } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } } } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - } - }, - "/orgs/{org}/codespaces/secrets/public-key": { - "get": { - "summary": "Get an organization public key", - "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/get-org-public-key", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key" - }, - "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": "Response when a configuration is updated", "content": { "application/json": { "schema": { - "title": "CodespacesPublicKey", - "description": "The public key used for setting Codespaces secrets.", "type": "object", + "description": "A code security configuration", "properties": { - "key_id": { - "description": "The identifier for the key.", + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { "type": "string", - "example": "1234567" + "description": "The name of the code security configuration. Must be unique within the organization." }, - "key": { - "description": "The Base64 encoded public key.", + "target_type": { "type": "string", - "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "id": { - "type": "integer", - "example": 2 + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] }, "url": { "type": "string", - "example": "https://api.github.com/user/keys/2" + "format": "uri", + "description": "The URL of the configuration" }, - "title": { + "html_url": { "type": "string", - "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + "format": "uri", + "description": "The URL of the configuration" }, "created_at": { "type": "string", - "example": "2011-01-26T19:01:12Z" + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } - }, - "required": [ - "key_id", - "key" - ] + } }, "examples": { "default": { "value": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings v2", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "disabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" } } } } } + }, + "204": { + "description": "Response when no new updates are made" } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - } - }, - "/orgs/{org}/codespaces/secrets/{secret_name}": { - "get": { - "summary": "Get an organization secret", - "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + }, + "delete": { + "summary": "Delete a code security configuration", + "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/get-org-secret", + "operationId": "code-security/delete-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration" }, "parameters": [ { @@ -111294,80 +111703,153 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "200": { - "description": "Response", + "204": { + "description": "A header with no content is returned." + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "title": "Codespaces Secret", - "description": "Secrets for a GitHub Codespace.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "name": { - "description": "The name of the secret", - "example": "SECRET_NAME", + "message": { "type": "string" }, - "created_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { - "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "documentation_url": { "type": "string", - "format": "date-time" + "nullable": true }, - "visibility": { - "description": "The type of repositories in the organization that the secret is visible to", - "enum": [ - "all", - "private", - "selected" - ], - "type": "string" + "detail": { + "type": "string", + "nullable": true }, - "selected_repositories_url": { - "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "status": { + "type": "integer" + }, + "scimType": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } } - }, - "required": [ - "name", - "created_at", - "updated_at", - "visibility" - ] - }, - "examples": { - "default": { - "value": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z", - "visibility": "all" + } + } + } + } + }, + "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" } } } } - }, - "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" + } + } + } + } + } + }, + "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" + } + } } } } @@ -111375,21 +111857,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } - }, - "put": { - "summary": "Create or update an organization secret", - "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach a configuration to repositories", + "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/create-or-update-org-secret", + "operationId": "code-security/attach-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories" }, "parameters": [ { @@ -111402,12 +111886,12 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -111417,46 +111901,40 @@ "application/json": { "schema": { "type": "object", + "additionalProperties": false, "properties": { - "encrypted_value": { - "type": "string", - "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - }, - "key_id": { - "type": "string", - "description": "The ID of the key you used to encrypt the secret." - }, - "visibility": { + "scope": { "type": "string", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", "enum": [ "all", - "private", + "all_without_configurations", + "public", + "private_or_internal", "selected" ] }, "selected_repository_ids": { "type": "array", - "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", "items": { - "type": "integer" + "type": "integer", + "description": "Unique identifier of the repository." } } }, "required": [ - "visibility" + "scope" ] }, "examples": { "default": { + "summary": "Example for attaching a configuration to some repositories", "value": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678", - "visibility": "selected", + "scope": "selected", "selected_repository_ids": [ - 1296269, - 1296280 + 32, + 91 ] } } @@ -111465,16 +111943,12 @@ } }, "responses": { - "201": { - "description": "Response when creating a secret", + "202": { + "description": "Accepted", "content": { "application/json": { "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false + "type": "object" }, "examples": { "default": { @@ -111483,48 +111957,418 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an organization", + "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/set-configuration-as-default", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "204": { - "description": "Response when updating a secret" - }, - "404": { - "description": "Resource not found", + { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] }, - "status": { - "type": "string" + "configuration": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } } } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -111532,98 +112376,16 @@ "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - }, - "delete": { - "summary": "Delete an organization secret", - "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/delete-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -111654,23 +112416,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" } } }, - "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { "get": { - "summary": "List selected repositories for an organization secret", - "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Get repositories associated with a code security configuration", + "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ - "codespaces" + "code-security" ], - "operationId": "codespaces/list-selected-repos-for-org-secret", + "operationId": "code-security/get-repositories-for-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" }, "parameters": [ { @@ -111683,30 +112445,50 @@ } }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "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).\"", + "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", + "required": false, "schema": { "type": "integer", - "default": 1 + "default": 30 } }, { - "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).\"", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. 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", + "required": false, "schema": { - "type": "integer", - "default": 30 + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. 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", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "all" } } ], @@ -111716,38 +112498,50 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "total_count", - "repositories" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "repositories": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "type": "array", + "items": { + "type": "object", + "description": "Repositories associated with a code security configuration and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", - "example": 1296269 + "example": 1296269, + "description": "A unique identifier of the repository." }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." }, "name": { "type": "string", - "example": "Hello-World" + "example": "Hello-World", + "description": "The name of the repository." }, "full_name": { "type": "string", - "example": "octocat/Hello-World" + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." }, "owner": { "title": "Simple User", @@ -111874,549 +112668,1717 @@ ] }, "private": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true + "nullable": true, + "description": "The repository description." }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." }, "releases_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." }, "stargazers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." }, "statuses_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." }, "subscribers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." }, "subscription_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." }, "tags_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." }, "teams_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." }, "trees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." }, "hooks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "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" + ] + } + } + } + }, + "examples": { + "default": { + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { + "value": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + } + } + ] + } + } + } + } + }, + "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": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/codespaces": { + "get": { + "summary": "List codespaces for the organization", + "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-in-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#list-codespaces-for-the-organization" + }, + "parameters": [ + { + "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 + } + }, + { + "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", + "codespaces" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "codespaces": { + "type": "array", + "items": { + "type": "object", + "title": "Codespace", + "description": "A codespace.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "svn_url": { - "type": "string" + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "example": "monalisa-octocat-hello-world-g4wpq6h95q" }, - "homepage": { + "display_name": { + "description": "Display name for this codespace.", "type": "string", + "example": "bookish space pancake", "nullable": true }, - "language": { + "environment_id": { + "description": "UUID identifying this codespace's environment.", "type": "string", + "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "nullable": true }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "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" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "admin": { - "type": "boolean" + "name": { + "nullable": true, + "type": "string" }, - "maintain": { - "type": "boolean" + "email": { + "nullable": true, + "type": "string" }, - "push": { - "type": "boolean" + "login": { + "type": "string", + "example": "octocat" }, - "triage": { - "type": "boolean" + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "example": "admin" - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { + "node_id": { "type": "string", - "example": "contributor_covenant" + "example": "MDQ6VXNlcjE=" }, - "name": { + "avatar_url": { "type": "string", - "example": "Contributor Covenant" + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + "example": "https://api.github.com/users/octocat" }, - "body": { + "html_url": { "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + "format": "uri", + "example": "https://github.com/octocat" }, - "html_url": { + "followers_url": { "type": "string", "format": "uri", - "nullable": true + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ - "url", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", - "key", - "name" + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, - "license": { + "billable_owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "key": { - "type": "string" - }, "name": { + "nullable": true, "type": "string" }, - "spdx_id": { + "email": { + "nullable": true, "type": "string" }, - "url": { - "type": "string" + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false + "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" + ] }, - "security_and_analysis": { - "nullable": true, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" } }, - "secret_scanning": { + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { "type": "object", "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } } }, - "secret_scanning_push_protection": { + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", "type": "object", "properties": { - "status": { + "key": { "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true } - } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] }, - "secret_scanning_non_provider_patterns": { + "license": { "type": "object", "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" } - } + }, + "nullable": true }, - "secret_scanning_ai_detection": { + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, "type": "object", "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } }, - "secret_scanning_validity_checks": { + "custom_properties": { "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "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" + ] + }, + "machine": { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "example": "standardLinux" + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "example": "4 cores, 16 GB RAM, 64 GB storage" + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "example": "linux" + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "example": 68719476736 + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "example": 17179869184 + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "example": 4 + }, + "prebuild_availability": { + "type": "string", + "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", + "example": "ready", + "enum": [ + "none", + "ready", + "in_progress" + ], + "nullable": true + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ], + "nullable": true + }, + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", + "type": "string", + "example": ".devcontainer/example/devcontainer.json", + "nullable": true + }, + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": "boolean", + "example": false, + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "last_used_at": { + "description": "Last known time this codespace was started.", + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "state": { + "description": "State of this codespace.", + "enum": [ + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "example": "Available", + "type": "string" + }, + "url": { + "description": "API URL for this codespace.", + "type": "string", + "format": "uri" + }, + "git_status": { + "description": "Details about the codespace's git repository.", + "type": "object", + "properties": { + "ahead": { + "description": "The number of commits the local repository is ahead of the remote.", + "type": "integer", + "example": 0 + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "example": 0 + }, + "has_unpushed_changes": { + "description": "Whether the local repository has unpushed changes.", + "type": "boolean" + }, + "has_uncommitted_changes": { + "description": "Whether the local repository has uncommitted changes.", + "type": "boolean" + }, + "ref": { + "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", + "type": "string", + "example": "main" } } }, - "custom_properties": { + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "example": "WestUs2", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": "integer", + "example": 60, + "nullable": true + }, + "web_url": { + "description": "URL to access this codespace on the web.", + "type": "string", + "format": "uri" + }, + "machines_url": { + "description": "API URL to access available alternate machine types for this codespace.", + "type": "string", + "format": "uri" + }, + "start_url": { + "description": "API URL to start this codespace.", + "type": "string", + "format": "uri" + }, + "stop_url": { + "description": "API URL to stop this codespace.", + "type": "string", + "format": "uri" + }, + "publish_url": { + "description": "API URL to publish this codespace to a new repository.", + "type": "string", + "format": "uri", + "nullable": true + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": "string", + "format": "uri", + "nullable": true + }, + "recent_folders": { + "type": "array", + "items": { + "type": "string" + } + }, + "runtime_constraints": { "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "properties": { + "allowed_port_privacy_settings": { + "description": "The privacy settings a user can select from when forwarding a port.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + }, + "pending_operation": { + "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", + "type": "boolean", + "nullable": true + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": "string", + "nullable": true + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": "string", + "nullable": true + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer", + "example": 60, + "nullable": true + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": "string", + "format": "date-time", + "example": "2011-01-26T20:01:12Z", + "nullable": true + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": "string", + "example": "you've used 100% of your spending limit for Codespaces", + "nullable": true } }, "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", + "environment_id", "owner", - "private", + "billable_owner", + "repository", + "machine", + "prebuild", + "created_at", + "updated_at", + "last_used_at", + "state", + "url", + "git_status", + "location", + "idle_timeout_minutes", + "web_url", + "machines_url", + "start_url", + "stop_url", "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" + "recent_folders" ] } } @@ -112425,13 +114387,12 @@ "examples": { "default": { "value": { - "total_count": 1, - "repositories": [ + "total_count": 3, + "codespaces": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, @@ -112452,49 +114413,410 @@ "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}", - "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/foobar/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "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": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-f8adfad99a", + "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "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 + }, + "billable_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 + }, + "repository": { + "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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", + "recent_folders": [] } ] } @@ -112503,8 +114825,11 @@ } } }, - "404": { - "description": "Resource not found", + "304": { + "description": "Not modified" + }, + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -112528,80 +114853,58 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "codespaces", - "subcategory": "organization-secrets" - } - }, - "put": { - "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "codespaces" - ], - "operationId": "codespaces/set-selected-repos-for-org-secret", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selected_repository_ids": { - "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", - "items": { - "type": "integer" + "401": { + "description": "Requires authentication", + "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": [ - "selected_repository_ids" - ] - }, - "examples": { - "default": { - "value": { - "selected_repository_ids": [ - 64780797 - ] + } + } + } + }, + "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" + } } } } } - } - }, - "responses": { - "204": { - "description": "Response" }, "404": { "description": "Resource not found", @@ -112628,30 +114931,27 @@ } } } - }, - "409": { - "description": "Conflict when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", - "subcategory": "organization-secrets" + "subcategory": "organizations" } } }, - "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + "/orgs/{org}/codespaces/access": { "put": { - "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Manage access control for organization codespaces", + "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], - "operationId": "codespaces/add-selected-repo-to-org-secret", + "operationId": "codespaces/set-codespaces-access", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces" }, "parameters": [ { @@ -112662,28 +114962,62 @@ "schema": { "type": "string" } - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repository_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "deprecated": true, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "visibility": { + "type": "string", + "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.", + "enum": [ + "disabled", + "selected_members", + "all_members", + "all_members_and_outside_collaborators" + ] + }, + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.", + "items": { + "type": "string" + }, + "maxItems": 100 + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "visibility": "selected_members", + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + } + } + } + } + } + }, "responses": { "204": { - "description": "No Content when repository was added to the selected list" + "description": "Response when successfully modifying permissions." + }, + "304": { + "description": "Not modified" + }, + "400": { + "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", @@ -112711,9 +115045,6 @@ } } }, - "409": { - "description": "Conflict when visibility type is not set to selected" - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -112782,25 +115113,53 @@ } } } - } - }, - "x-github": { + }, + "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" + } + } + } + } + } + } + }, + "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", - "subcategory": "organization-secrets" + "subcategory": "organizations" } - }, - "delete": { - "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + } + }, + "/orgs/{org}/codespaces/access/selected_users": { + "post": { + "summary": "Add users to Codespaces access for an organization", + "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "codespaces" ], - "operationId": "codespaces/remove-selected-repo-from-org-secret", + "operationId": "codespaces/set-codespaces-access-users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" }, "parameters": [ { @@ -112811,28 +115170,246 @@ "schema": { "type": "string" } + } + ], + "deprecated": true, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members whose codespaces be billed to the organization.", + "items": { + "type": "string" + }, + "maxItems": 100 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response when successfully modifying permissions." }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "304": { + "description": "Not modified" + }, + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } } }, + "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" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" + } + }, + "delete": { + "summary": "Remove users from Codespaces access for an organization", + "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-codespaces-access-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" + }, + "deprecated": true, + "parameters": [ { - "name": "repository_id", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members whose codespaces should not be billed to the organization.", + "items": { + "type": "string" + }, + "maxItems": 100 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + } + } + } + } + } + }, "responses": { "204": { - "description": "Response when repository was removed from the selected list" + "description": "Response when successfully modifying permissions." + }, + "304": { + "description": "Not modified" + }, + "400": { + "description": "Users are neither members nor collaborators of this organization." }, "404": { "description": "Resource not found", @@ -112860,9 +115437,6 @@ } } }, - "409": { - "description": "Conflict when visibility type not set to selected" - }, "422": { "description": "Validation failed, or the endpoint has been spammed.", "content": { @@ -112931,27 +115505,53 @@ } } } + }, + "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" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "category": "codespaces", - "subcategory": "organization-secrets" + "subcategory": "organizations" } } }, - "/orgs/{org}/copilot/billing": { + "/orgs/{org}/codespaces/secrets": { "get": { - "summary": "Get Copilot seat information and settings for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "summary": "List organization secrets", + "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/get-copilot-organization-details", + "operationId": "codespaces/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets" }, "parameters": [ { @@ -112962,162 +115562,433 @@ "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": "OK", + "description": "Response", "content": { "application/json": { "schema": { - "title": "Copilot Organization Details", - "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", "type": "object", + "required": [ + "total_count", + "secrets" + ], "properties": { - "seat_breakdown": { - "title": "Copilot Seat Breakdown", - "description": "The breakdown of Copilot Business seats for the organization.", - "type": "object", - "properties": { - "total": { - "type": "integer", - "description": "The total number of seats being billed for the organization as of the current billing cycle." - }, - "added_this_cycle": { - "type": "integer", - "description": "Seats added during the current billing cycle." - }, - "pending_cancellation": { - "type": "integer", - "description": "The number of seats that are pending cancellation at the end of the current billing cycle." - }, - "pending_invitation": { - "type": "integer", - "description": "The number of users who have been invited to receive a Copilot seat through this organization." + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret", + "example": "SECRET_NAME", + "type": "string" + }, + "created_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "The type of repositories in the organization that the secret is visible to", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + } }, - "active_this_cycle": { - "type": "integer", - "description": "The number of seats that have used Copilot during the current billing cycle." + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" }, - "inactive_this_cycle": { - "type": "integer", - "description": "The number of seats that have not used Copilot during the current billing cycle." + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z", + "visibility": "all" } - } - }, - "public_code_suggestions": { - "type": "string", - "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", - "enum": [ - "allow", - "block", - "unconfigured" ] - }, - "ide_chat": { + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key" + }, + "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": "CodespacesPublicKey", + "description": "The public key used for setting Codespaces secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", "type": "string", - "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] + "example": "1234567" }, - "platform_chat": { + "key": { + "description": "The Base64 encoded public key.", "type": "string", - "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" }, - "cli": { + "id": { + "type": "integer", + "example": 2 + }, + "url": { "type": "string", - "description": "The organization policy for allowing or disallowing Copilot in the CLI.", - "enum": [ - "enabled", - "disabled", - "unconfigured" - ] + "example": "https://api.github.com/user/keys/2" }, - "seat_management_setting": { + "title": { "type": "string", - "description": "The mode of assigning new seats.", - "enum": [ - "assign_all", - "assign_selected", - "disabled", - "unconfigured" - ] + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" }, - "plan_type": { + "created_at": { "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise" - ] + "example": "2011-01-26T19:01:12Z" } }, "required": [ - "seat_breakdown", - "public_code_suggestions", - "seat_management_setting" - ], - "additionalProperties": true + "key_id", + "key" + ] }, "examples": { "default": { "value": { - "seat_breakdown": { - "total": 12, - "added_this_cycle": 9, - "pending_invitation": 0, - "pending_cancellation": 0, - "active_this_cycle": 12, - "inactive_this_cycle": 11 - }, - "seat_management_setting": "assign_selected", - "ide_chat": "enabled", - "platform_chat": "enabled", - "cli": "enabled", - "public_code_suggestions": "block", - "plan_type": "business" + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "500": { - "description": "Internal Error", + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", "type": "object", "properties": { - "message": { + "name": { + "description": "The name of the secret", + "example": "SECRET_NAME", "type": "string" }, - "documentation_url": { - "type": "string" + "created_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" }, - "url": { - "type": "string" + "updated_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" }, - "status": { + "visibility": { + "description": "The type of repositories in the organization that the secret is visible to", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" + }, + "selected_repositories_url": { + "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" } } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, - "401": { - "description": "Requires authentication", + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "The ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -113142,14 +116013,18 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" @@ -113157,16 +116032,98 @@ "documentation_url": { "type": "string" }, - "url": { - "type": "string" - }, - "status": { - "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -113193,30 +116150,27 @@ } } } - }, - "422": { - "description": "There is a problem with your account's associated payment method." } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/copilot/billing/seats": { + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { "get": { - "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/list-copilot-seats", + "operationId": "codespaces/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -113228,6 +116182,15 @@ "type": "string" } }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "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).\"", @@ -113243,7 +116206,7 @@ "in": "query", "schema": { "type": "integer", - "default": 50 + "default": 30 } } ], @@ -113254,19 +116217,39 @@ "application/json": { "schema": { "type": "object", + "required": [ + "total_count", + "repositories" + ], "properties": { - "total_seats": { - "type": "integer", - "description": "Total number of Copilot seats for the organization currently being billed." + "total_count": { + "type": "integer" }, - "seats": { + "repositories": { "type": "array", "items": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "assignee": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -113388,371 +116371,553 @@ "subscriptions_url", "type", "url" - ], + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true }, - "organization": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "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" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { "type": "object", "properties": { - "login": { - "type": "string", - "example": "github" + "admin": { + "type": "boolean" }, - "id": { - "type": "integer", - "example": 1 + "maintain": { + "type": "boolean" }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "push": { + "type": "boolean" }, - "url": { + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" + "example": "contributor_covenant" }, - "repos_url": { + "name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" + "example": "Contributor Covenant" }, - "events_url": { + "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/orgs/github/events" + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, - "hooks_url": { + "body": { "type": "string", - "example": "https://api.github.com/orgs/github/hooks" + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, - "issues_url": { + "html_url": { "type": "string", - "example": "https://api.github.com/orgs/github/issues" + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" + "name": { + "type": "string" }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" + "spdx_id": { + "type": "string" }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" + "url": { + "type": "string" }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true + "node_id": { + "type": "string" } }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ], "nullable": true }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { + "status": { "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" + "enum": [ + "enabled", + "disabled" ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] + } }, - { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", + "code_security": { "type": "object", "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { + "status": { "type": "string", - "example": "disabled | all" - }, - "organization_selection_type": { + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", "type": "string", - "example": "disabled | all" - }, - "group_id": { - "nullable": true, + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { "type": "string", - "example": "62ab9291-fae2-468e-974b-7e45096d5021" - }, - "group_name": { - "nullable": true, + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { "type": "string", - "example": "Justice League" - }, - "html_url": { + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/dc/teams/justice-league" - }, - "members_url": { - "type": "string" - }, - "created_at": { + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "date-time" - }, - "updated_at": { + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_validity_checks": { + "type": "object", + "properties": { + "status": { "type": "string", - "format": "date-time" + "enum": [ + "enabled", + "disabled" + ] } - }, - "required": [ - "id", - "url", - "members_url", - "name", - "html_url", - "slug", - "created_at", - "updated_at" - ] + } } - ], - "nullable": true - }, - "pending_cancellation_date": { - "type": "string", - "format": "date", - "nullable": true, - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": "string", - "nullable": true, - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + } }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" - ] + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "created_at" - ], - "additionalProperties": false + "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" + ] } } } @@ -113760,16 +116925,14 @@ "examples": { "default": { "value": { - "total_seats": 2, - "seats": [ + "total_count": 1, + "repositories": [ { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "plan_type": "business", - "assignee": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -113789,66 +116952,59 @@ "type": "User", "site_admin": false }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/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}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -113872,58 +117028,80 @@ } } } - }, - "401": { - "description": "Requires authentication", - "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": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "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" + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" } } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } } } } + } + }, + "responses": { + "204": { + "description": "Response" }, "404": { "description": "Resource not found", @@ -113950,27 +117128,30 @@ } } } + }, + "409": { + "description": "Conflict when visibility type not set to selected" } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-user-management" + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" } } }, - "/orgs/{org}/copilot/billing/selected_teams": { - "post": { - "summary": "Add teams to the Copilot subscription for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ - "copilot" + "codespaces" ], - "operationId": "copilot/add-copilot-seats-for-teams", + "operationId": "codespaces/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -113981,10 +117162,1329 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "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 when visibility type is not set to selected" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "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 when visibility type not set to selected" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/copilot/billing": { + "get": { + "summary": "Get Copilot seat information and settings for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/get-copilot-organization-details", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-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": "OK", + "content": { + "application/json": { + "schema": { + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", + "type": "object", + "properties": { + "seat_breakdown": { + "title": "Copilot Seat Breakdown", + "description": "The breakdown of Copilot Business seats for the organization.", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of seats being billed for the organization as of the current billing cycle." + }, + "added_this_cycle": { + "type": "integer", + "description": "Seats added during the current billing cycle." + }, + "pending_cancellation": { + "type": "integer", + "description": "The number of seats that are pending cancellation at the end of the current billing cycle." + }, + "pending_invitation": { + "type": "integer", + "description": "The number of users who have been invited to receive a Copilot seat through this organization." + }, + "active_this_cycle": { + "type": "integer", + "description": "The number of seats that have used Copilot during the current billing cycle." + }, + "inactive_this_cycle": { + "type": "integer", + "description": "The number of seats that have not used Copilot during the current billing cycle." + } + } + }, + "public_code_suggestions": { + "type": "string", + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" + ] + }, + "ide_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "platform_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "cli": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot in the CLI.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "seat_management_setting": { + "type": "string", + "description": "The mode of assigning new seats.", + "enum": [ + "assign_all", + "assign_selected", + "disabled", + "unconfigured" + ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise" + ] + } + }, + "required": [ + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true + }, + "examples": { + "default": { + "value": { + "seat_breakdown": { + "total": 12, + "added_this_cycle": 9, + "pending_invitation": 0, + "pending_cancellation": 0, + "active_this_cycle": 12, + "inactive_this_cycle": 11 + }, + "seat_management_setting": "assign_selected", + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "There is a problem with your account's associated payment method." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/seats": { + "get": { + "summary": "List all Copilot seat assignments for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/list-copilot-seats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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 + } + }, + { + "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": 50 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_seats": { + "type": "integer", + "description": "Total number of Copilot seats for the organization currently being billed." + }, + "seats": { + "type": "array", + "items": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "type": "object", + "properties": { + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ], + "nullable": true + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "example": "disabled | all" + }, + "organization_selection_type": { + "type": "string", + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "string", + "example": "62ab9291-fae2-468e-974b-7e45096d5021" + }, + "group_name": { + "nullable": true, + "type": "string", + "example": "Justice League" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] + } + ], + "nullable": true + }, + "pending_cancellation_date": { + "type": "string", + "format": "date", + "nullable": true, + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": "string", + "nullable": true, + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] + } + }, + "required": [ + "created_at" + ], + "additionalProperties": false + } + } + } + }, + "examples": { + "default": { + "value": { + "total_seats": 2, + "seats": [ + { + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "plan_type": "business", + "assignee": { + "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 + }, + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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" + } + } + } + } + } + }, + "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": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/selected_teams": { + "post": { + "summary": "Add teams to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-copilot-seats-for-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "type": "object", @@ -125874,6 +130374,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -137257,6 +141781,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -141639,7 +146187,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -178177,6 +182725,639 @@ } } }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "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": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } + } + } + } + } + }, + "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" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update organization pattern configurations", + "description": "Updates the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "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": { + "pattern_config_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "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" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, "/orgs/{org}/security-advisories": { "get": { "summary": "List repository security advisories for an organization", @@ -211575,6 +216756,851 @@ } } }, + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for a repository", + "description": "Gets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "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": { + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "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" + } + }, + "put": { + "summary": "Set artifact and log retention settings for a repository", + "description": "Sets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "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": { + "default": { + "summary": "Set retention days", + "value": { + "days": 90 + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for a repository", + "description": "Gets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for a repository", + "description": "Sets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for a repository", + "description": "Gets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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 + } + } + } + } + } + }, + "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, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for a repository", + "description": "Sets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. 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" + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/repos/{owner}/{repo}/actions/permissions/selected-actions": { "get": { "summary": "Get allowed actions and reusable workflows for a repository", @@ -322178,6 +328204,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -342050,6 +348100,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -344623,6 +350697,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -350630,6 +356728,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -351784,9 +357906,6310 @@ "value": [ { "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "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 + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/events/{event_id}": { + "get": { + "summary": "Get an issue event", + "description": "Gets a single event by the event id.", + "tags": [ + "issues" + ], + "operationId": "issues/get-event", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "event_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue Event", + "description": "Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEwOklzc3VlRXZlbnQx" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + }, + "actor": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "event": { + "type": "string", + "example": "closed" + }, + "commit_id": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "commit_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ], + "nullable": true + }, + "label": { + "title": "Issue Event Label", + "description": "Issue Event Label", + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "color" + ] + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assigner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "review_requester": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "requested_reviewer": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "requested_team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "dismissed_review": { + "title": "Issue Event Dismissed Review", + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": "string", + "nullable": true + }, + "dismissal_commit_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" + ] + }, + "milestone": { + "title": "Issue Event Milestone", + "description": "Issue Event Milestone", + "type": "object", + "properties": { + "title": { + "type": "string" + } + }, + "required": [ + "title" + ] + }, + "project_card": { + "title": "Issue Event Project Card", + "description": "Issue Event Project Card", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "url", + "id", + "project_url", + "project_id", + "column_name" + ] + }, + "rename": { + "title": "Issue Event Rename", + "description": "Issue Event Rename", + "type": "object", + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + }, + "required": [ + "from", + "to" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "lock_reason": { + "type": "string", + "nullable": true + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "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 + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "performed_via_github_app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "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", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "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", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}": { + "get": { + "summary": "Get an issue", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -351805,176 +364228,119 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "issue": { - "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "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 - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "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 - }, - "assignees": [ - { - "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 - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR", - "state_reason": "completed" } - } - ] + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } } } } }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -351982,76 +364348,64 @@ "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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" } } } } } + }, + "304": { + "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "events" + "subcategory": "issues" } - } - }, - "/repos/{owner}/{repo}/issues/events/{event_id}": { - "get": { - "summary": "Get an issue event", - "description": "Gets a single event by the event id.", + }, + "patch": { + "summary": "Update an issue", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/get-event", + "operationId": "issues/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue" }, "parameters": [ { @@ -352073,7 +364427,8 @@ } }, { - "name": "event_id", + "name": "issue_number", + "description": "The number that identifies the issue.", "in": "path", "required": true, "schema": { @@ -352081,31 +364436,207 @@ } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "description": "The title of the issue.", + "nullable": true + }, + "body": { + "type": "string", + "description": "The contents of the issue.", + "nullable": true + }, + "assignee": { + "type": "string", + "nullable": true, + "description": "Username to assign to this issue. **This field is closing down.**" + }, + "state": { + "type": "string", + "description": "The open or closed state of the issue.", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "enum": [ + "completed", + "not_planned", + "duplicate", + "reopened" + ], + "nullable": true, + "description": "The reason for the state change. Ignored unless `state` is changed.", + "example": "not_planned" + }, + "milestone": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer", + "description": "The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped." + } + ], + "nullable": true + }, + "labels": { + "type": "array", + "description": "Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + } + } + ] + } + }, + "assignees": { + "type": "array", + "description": "Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.", + "nullable": true, + "example": "Epic" + } + } + }, + "examples": { + "default": { + "value": { + "title": "Found a bug", + "body": "I'm having a problem with this.", + "assignees": [ + "octocat" + ], + "milestone": 1, + "state": "open", + "labels": [ + "bug" + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Issue Event", - "description": "Issue Event", + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", - "format": "int64", - "example": 1 + "format": "int64" }, "node_id": { - "type": "string", - "example": "MDEwOklzc3VlRXZlbnQx" + "type": "string" }, "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + "format": "uri" }, - "actor": { + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -352230,96 +364761,358 @@ ], "nullable": true }, - "event": { - "type": "string", - "example": "closed" - }, - "commit_id": { - "type": "string", - "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true - }, - "commit_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } }, - "issue": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { "type": "integer", - "format": "int64" + "format": "int64", + "example": 1 }, "node_id": { - "type": "string" + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "repository_url": { + "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://github.com/octocat" }, - "labels_url": { - "type": "string" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "comments_url": { + "following_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, "events_url": { "type": "string", - "format": "uri" + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, "html_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, "state": { - "description": "State of the issue; either 'open' or 'closed'", + "description": "The state of the milestone.", "example": "open", - "type": "string" - }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", "type": "string", - "nullable": true, "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] + "open", + "closed" + ], + "default": "open" }, "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "description": "The title of the milestone.", + "example": "v1.0", "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "description": { "type": "string", + "example": "Tracking milestone for version 1.0", "nullable": true }, - "user": { + "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -352444,52 +365237,409 @@ ], "nullable": true }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } + "nullable": true }, - "assignee": { + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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", @@ -352611,718 +365761,546 @@ "subscriptions_url", "type", "url" - ], + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true }, - "assignees": { + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { "type": "array", "items": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - "nullable": true + "type": "string" + } }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", "nullable": true }, - "locked": { - "type": "boolean" + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true }, - "active_lock_reason": { + "updated_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", "nullable": true }, - "comments": { - "type": "integer" + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "temp_clone_token": { + "type": "string" }, - "closed_at": { + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", - "format": "date-time", - "nullable": true + "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)." }, - "created_at": { + "squash_merge_commit_message": { "type": "string", - "format": "date-time" + "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." }, - "updated_at": { + "merge_commit_title": { "type": "string", - "format": "date-time" + "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)." }, - "draft": { + "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", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", "type": "boolean" }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" }, - "body_html": { - "type": "string" + "open_issues": { + "type": "integer" }, - "body_text": { + "watchers": { + "type": "integer" + }, + "master_branch": { "type": "string" }, - "timeline_url": { + "starred_at": { "type": "string", - "format": "uri" + "example": "\"2020-07-09T00:17:42Z\"" }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { "type": "object", - "nullable": true, + "description": "The status of the code search index for this repository", "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" + "lexical_search_ok": { + "type": "boolean" }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." + "lexical_commit_sha": { + "type": "string" } - }, - "required": [ - "id", - "node_id", - "name", - "description" - ] + } + } + }, + "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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "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": { + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -353446,957 +366424,813 @@ "url" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"2020-07-09T00:17:42Z\"" - }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" - }, - "code_search_index_status": { + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", "type": "object", - "description": "The status of the code search index for this repository", "properties": { - "lexical_search_ok": { - "type": "boolean" + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true }, - "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" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" }, - "checks": { - "type": "string" + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" }, - "metadata": { - "type": "string" + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "contents": { - "type": "string" + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" }, - "deployments": { - "type": "string" + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" } }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" ] }, - "author_association": { - "title": "author_association", + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "example": "The description of the app.", + "nullable": true }, - "reactions": { - "title": "Reaction Rollup", + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" + "issues": { + "type": "string" }, - "heart": { - "type": "integer" + "checks": { + "type": "string" }, - "hooray": { - "type": "integer" + "metadata": { + "type": "string" }, - "eyes": { - "type": "integer" + "contents": { + "type": "string" }, - "rocket": { - "type": "integer" + "deployments": { + "type": "string" } }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" - }, - "percent_completed": { - "type": "integer" - } + "additionalProperties": { + "type": "string" }, - "required": [ - "total", - "completed", - "percent_completed" - ] + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", "id", "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", + "owner", + "name", + "description", + "external_url", + "html_url", "created_at", - "updated_at" + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "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 + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } ], - "nullable": true + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + } + } + } + }, + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "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" + } + } + } + } + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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": "issues", + "subcategory": "issues" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + "post": { + "summary": "Add assignees to an issue", + "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", + "tags": [ + "issues" + ], + "operationId": "issues/add-assignees", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "type": "array", + "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "assignees": [ + "hubot", + "other_user" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, - "label": { - "title": "Issue Event Label", - "description": "Issue Event Label", - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - } - }, - "required": [ - "name", - "color" + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" ] }, - "assignee": { + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -354521,7 +367355,52 @@ ], "nullable": true }, - "assigner": { + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -354646,132 +367525,426 @@ ], "nullable": true }, - "review_requester": { - "title": "Simple User", - "description": "A GitHub user.", + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, - "email": { - "nullable": true, - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, - "login": { + "labels_url": { "type": "string", - "example": "octocat" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, "id": { "type": "integer", - "format": "int64", - "example": 1 + "example": 1002604 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, - "gravatar_id": { + "state": { + "description": "The state of the milestone.", + "example": "open", "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "enum": [ + "open", + "closed" + ], + "default": "open" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" }, - "html_url": { + "description": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "Tracking milestone for version 1.0", + "nullable": true }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "open_issues": { + "type": "integer", + "example": 4 }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "closed_issues": { + "type": "integer", + "example": 8 }, - "starred_url": { + "created_at": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "date-time", + "example": "2011-04-10T20:09:31Z" }, - "subscriptions_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, - "organizations_url": { + "closed_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true }, - "repos_url": { + "due_on": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "nullable": true }, - "received_events_url": { + "diff_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "nullable": true }, - "type": { + "html_url": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "format": "uri", + "nullable": true }, - "starred_at": { + "patch_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri", + "nullable": true }, - "user_view_type": { + "url": { "type": "string", - "example": "public" + "format": "uri", + "nullable": true } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "diff_url", "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "patch_url", "url" - ], + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", "nullable": true }, - "requested_reviewer": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -354896,39 +368069,151 @@ ], "nullable": true }, - "requested_team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", "type": "object", + "nullable": true, "properties": { "id": { - "type": "integer" + "type": "integer", + "description": "The unique identifier of the issue type." }, "node_id": { - "type": "string" + "type": "string", + "description": "The node identifier of the issue type." }, "name": { - "type": "string" - }, - "slug": { - "type": "string" + "type": "string", + "description": "The name of the issue type." }, "description": { "type": "string", + "description": "The description of the issue type.", "nullable": true }, - "privacy": { - "type": "string" + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true }, - "notification_setting": { - "type": "string" + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" }, - "permission": { - "type": "string" + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" }, "permissions": { "type": "object", "properties": { + "admin": { + "type": "boolean" + }, "pull": { "type": "boolean" }, @@ -354940,243 +368225,649 @@ }, "maintain": { "type": "boolean" - }, - "admin": { - "type": "boolean" } }, "required": [ + "admin", "pull", - "triage", - "push", - "maintain", - "admin" + "push" ] }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "owner": { + "title": "Simple User", + "description": "A GitHub user.", "type": "object", "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { - "description": "Unique identifier of the team", "type": "integer", + "format": "int64", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VGVhbTE=" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { - "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" + "example": "https://api.github.com/users/octocat" }, - "members_url": { + "html_url": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "format": "uri", + "example": "https://github.com/octocat" }, - "name": { - "description": "Name of the team", + "followers_url": { "type": "string", - "example": "Justice League" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "description": { - "description": "Description of the team", + "following_url": { "type": "string", - "nullable": true, - "example": "A great team." + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "permission": { - "description": "Permission that the team will have for its repositories", + "gists_url": { "type": "string", - "example": "admin" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "privacy": { - "description": "The level of privacy this team should have", + "starred_url": { "type": "string", - "example": "closed" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "notification_setting": { - "description": "The notification setting the team has set", + "subscriptions_url": { "type": "string", - "example": "notifications_enabled" + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "html_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "example": "https://api.github.com/users/octocat/orgs" }, - "repositories_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "example": "https://api.github.com/users/octocat/repos" }, - "slug": { + "events_url": { "type": "string", - "example": "justice-league" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", "nullable": true - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - "dismissed_review": { - "title": "Issue Event Dismissed Review", - "type": "object", - "properties": { - "state": { + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "review_id": { - "type": "integer" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true }, - "dismissal_message": { + "created_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", "nullable": true }, - "dismissal_commit_id": { + "updated_at": { "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", "nullable": true - } - }, - "required": [ - "state", - "review_id", - "dismissal_message" - ] - }, - "milestone": { - "title": "Issue Event Milestone", - "description": "Issue Event Milestone", - "type": "object", - "properties": { - "title": { + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { "type": "string" - } - }, - "required": [ - "title" - ] - }, - "project_card": { - "title": "Issue Event Project Card", - "description": "Issue Event Project Card", - "type": "object", - "properties": { - "url": { + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", - "format": "uri" + "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)." }, - "id": { - "type": "integer" + "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." }, - "project_url": { + "merge_commit_title": { "type": "string", - "format": "uri" + "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)." }, - "project_id": { + "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", + "example": 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" }, - "column_name": { - "type": "string" + "watchers": { + "type": "integer" }, - "previous_column_name": { - "type": "string" - } - }, - "required": [ - "url", - "id", - "project_url", - "project_id", - "column_name" - ] - }, - "rename": { - "title": "Issue Event Rename", - "description": "Issue Event Rename", - "type": "object", - "properties": { - "from": { + "master_branch": { "type": "string" }, - "to": { - "type": "string" + "starred_at": { + "type": "string", + "example": "\"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": [ - "from", - "to" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "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" ] }, - "lock_reason": { - "type": "string", - "nullable": true - }, "performed_via_github_app": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -355485,26 +369176,157 @@ "permissions", "events" ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", - "actor", - "event", - "commit_id", - "commit_url", - "created_at" + "user", + "author_association", + "created_at", + "updated_at" ] }, "examples": { "default": { "value": { "id": 1, - "node_id": "MDEwOklzc3VlRXZlbnQx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", - "actor": { + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -355524,24 +369346,39 @@ "type": "User", "site_admin": false }, - "event": "closed", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "created_at": "2011-04-14T16:00:49Z", - "issue": { + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { + "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 + }, + "assignees": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -355560,19 +369397,19 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -355592,198 +369429,47 @@ "type": "User", "site_admin": false }, - "assignees": [ - { - "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 - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "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 - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "performed_via_github_app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "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", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "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", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - }, - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "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" + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -355795,21 +369481,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "events" + "subcategory": "assignees" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}": { - "get": { - "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + }, + "delete": { + "summary": "Remove assignees from an issue", + "description": "Removes one or more assignees from an issue.", "tags": [ "issues" ], - "operationId": "issues/get", + "operationId": "issues/remove-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue" }, "parameters": [ { @@ -355840,6 +369524,34 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "type": "array", + "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "assignees": [ + "hubot", + "other_user" + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", @@ -357946,6 +371658,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -358136,9 +371872,71 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + "get": { + "summary": "Check if a user can be assigned to a issue", + "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", + "tags": [ + "issues" + ], + "operationId": "issues/check-user-can-be-assigned-to-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "301": { - "description": "Moved permanently", + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "assignee", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if `assignee` can be assigned to `issue_number`" + }, + "404": { + "description": "Response if `assignee` can not be assigned to `issue_number`", "content": { "application/json": { "schema": { @@ -358162,6 +371960,701 @@ } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "get": { + "summary": "List issue comments", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-comments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "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": "array", + "items": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "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 + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } }, "404": { "description": "Resource not found", @@ -358214,28 +372707,25 @@ } } } - }, - "304": { - "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "comments" } }, - "patch": { - "summary": "Update an issue", - "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "post": { + "summary": "Create an issue comment", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/update", + "operationId": "issues/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment" }, "parameters": [ { @@ -358267,124 +372757,25 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "The title of the issue.", - "nullable": true - }, "body": { "type": "string", - "description": "The contents of the issue.", - "nullable": true - }, - "assignee": { - "type": "string", - "nullable": true, - "description": "Username to assign to this issue. **This field is closing down.**" - }, - "state": { - "type": "string", - "description": "The open or closed state of the issue.", - "enum": [ - "open", - "closed" - ] - }, - "state_reason": { - "type": "string", - "enum": [ - "completed", - "not_planned", - "duplicate", - "reopened" - ], - "nullable": true, - "description": "The reason for the state change. Ignored unless `state` is changed.", - "example": "not_planned" - }, - "milestone": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped." - } - ], - "nullable": true - }, - "labels": { - "type": "array", - "description": "Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - } - } - } - ] - } - }, - "assignees": { - "type": "array", - "description": "Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.", - "items": { - "type": "string" - } - }, - "type": { - "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.", - "nullable": true, - "example": "Epic" + "description": "The contents of the comment." } - } + }, + "required": [ + "body" + ] }, "examples": { "default": { "value": { - "title": "Found a bug", - "body": "I'm having a problem with this.", - "assignees": [ - "octocat" - ], - "milestone": 1, - "state": "open", - "labels": [ - "bug" - ] + "body": "Me too" } } } @@ -358392,16 +372783,18 @@ } }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the issue comment", + "example": 42, "type": "integer", "format": "int64" }, @@ -358409,62 +372802,25 @@ "type": "string" }, "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", "type": "string", "format": "uri" }, - "labels_url": { + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", "type": "string" }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", + "body_text": { "type": "string" }, - "state_reason": { - "description": "The reason for the current state", - "example": "not_planned", - "type": "string", - "nullable": true, - "enum": [ - "completed", - "reopened", - "not_planned", - "duplicate" - ] - }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", + "body_html": { "type": "string" }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "html_url": { "type": "string", - "nullable": true + "format": "uri" }, "user": { "title": "Simple User", @@ -358591,179 +372947,747 @@ ], "nullable": true }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" }, - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", + "nullable": true, "properties": { - "name": { - "nullable": true, - "type": "string" + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" }, - "email": { - "nullable": true, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", "type": "string" }, - "login": { + "node_id": { "type": "string", - "example": "octocat" + "example": "MDExOkludGVncmF0aW9uMQ==" }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" }, - "node_id": { + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "The description of the app.", + "nullable": true }, - "avatar_url": { + "external_url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "https://example.com" }, - "gravatar_id": { + "html_url": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "total_count": { + "type": "integer" }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "+1": { + "type": "integer" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "-1": { + "type": "integer" }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "laugh": { + "type": "integer" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "confused": { + "type": "integer" }, - "type": { - "type": "string", - "example": "User" + "heart": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "hooray": { + "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "eyes": { + "type": "integer" }, - "user_view_type": { - "type": "string", - "example": "public" + "rocket": { + "type": "integer" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "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 + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "assignees": { + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + "get": { + "summary": "List dependencies an issue is blocked by", + "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -358885,64 +373809,182 @@ "subscriptions_url", "type", "url" - ] + ], + "nullable": true }, - "nullable": true - }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "creator": { + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -359064,1533 +374106,1686 @@ "subscriptions_url", "type", "url" - ], - "nullable": true - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true + ] }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } + "nullable": true }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ], - "nullable": true - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "draft": { - "type": "boolean" - }, - "closed_by": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "locked": { + "type": "boolean" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "type": { - "title": "Issue Type", - "description": "The type of issue.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the issue type." - }, - "node_id": { - "type": "string", - "description": "The node identifier of the issue type." - }, - "name": { - "type": "string", - "description": "The name of the issue type." - }, - "description": { - "type": "string", - "description": "The description of the issue type.", - "nullable": true - }, - "color": { - "type": "string", - "description": "The color of the issue type.", - "enum": [ - "gray", - "blue", - "green", - "yellow", - "orange", - "red", - "pink", - "purple" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The time the issue type created.", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "description": "The time the issue type last updated.", - "format": "date-time" - }, - "is_enabled": { - "type": "boolean", - "description": "The enabled state of the issue type." - } + "active_lock_reason": { + "type": "string", + "nullable": true }, - "required": [ - "id", - "node_id", - "name", - "description" - ] - }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "html_url": { - "type": "string", - "format": "uri" + "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" } }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, - "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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" + }, + "starred_at": { + "type": "string", + "example": "\"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" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "required": [ + "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" + ] + }, + "performed_via_github_app": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } }, - "user_view_type": { - "type": "string", - "example": "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" + ] }, - "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" + { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } }, - "avatar_url": { - "type": "string", - "format": "uri" - } + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "contents": { + "additionalProperties": { "type": "string" }, - "deployments": { - "type": "string" + "example": { + "issues": "read", + "deployments": "write" } }, - "additionalProperties": { - "type": "string" + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } }, - "example": { - "issues": "read", - "deployments": "write" + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" } }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" } }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } }, - "rocket": { - "type": "integer" - } + "required": [ + "total", + "completed", + "percent_completed" + ] }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "sub_issues_summary": { - "title": "Sub-issues Summary", - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "completed": { - "type": "integer" + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } }, - "percent_completed": { - "type": "integer" - } - }, - "required": [ - "total", - "completed", - "percent_completed" - ] - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at" - ] + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } }, "examples": { "default": { - "value": { - "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "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 - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "login": "octocat", + "value": [ + { "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 - }, - "assignees": [ - { + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -360609,19 +375804,19 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -360641,165 +375836,110 @@ "type": "User", "site_admin": false }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "closed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "author_association": "COLLABORATOR", - "state_reason": "completed" - } - } - } - } - } - }, - "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" + "assignees": [ + { + "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 + } ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" } - } - } - } - } - } - }, - "503": { - "description": "Service unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } + ] } } } - } - }, - "403": { - "description": "Forbidden", - "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" } } } @@ -360887,21 +376027,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "issues" + "subcategory": "issue-dependencies" } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + }, "post": { - "summary": "Add assignees to an issue", - "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", + "summary": "Add a dependency an issue is blocked by", + "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/add-assignees", + "operationId": "issues/add-blocked-by-dependency", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -360933,28 +376071,25 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "assignees": { - "type": "array", - "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "items": { - "type": "string" - } + "issue_id": { + "type": "integer", + "description": "The id of the issue that blocks the current issue" } - } + }, + "required": [ + "issue_id" + ] }, "examples": { "default": { "value": { - "assignees": [ - "hubot", - "other_user" - ] + "issue_id": 1 } } } @@ -363067,6 +378202,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -363256,26 +378415,210 @@ } } } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "description": "Moved permanently", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "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" + } + } + } + } } } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "assignees" + "subcategory": "issue-dependencies" } - }, + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { "delete": { - "summary": "Remove assignees from an issue", - "description": "Removes one or more assignees from an issue.", + "summary": "Remove dependency an issue is blocked by", + "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/remove-assignees", + "operationId": "issues/remove-dependency-blocked-by", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" }, "parameters": [ { @@ -363304,36 +378647,17 @@ "schema": { "type": "integer" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "assignees": { - "type": "array", - "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "assignees": [ - "hubot", - "other_user" - ] - } - } - } + }, + { + "name": "issue_id", + "in": "path", + "description": "The id of the blocking issue to remove as a dependency", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { "200": { "description": "Response", @@ -365440,6 +380764,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -365630,71 +380978,173 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "assignees" - } - } - }, - "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { - "get": { - "summary": "Check if a user can be assigned to a issue", - "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", - "tags": [ - "issues" - ], - "operationId": "issues/check-user-can-be-assigned-to-issue", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" + "301": { + "description": "Moved permanently", + "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" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } } }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" + "401": { + "description": "Requires authentication", + "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": "assignee", - "in": "path", - "required": true, - "schema": { - "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" + } + } + } + } } - } - ], - "responses": { - "204": { - "description": "Response if `assignee` can be assigned to `issue_number`" }, "404": { - "description": "Response if `assignee` can not be assigned to `issue_number`", + "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" + } + } + } + } + } + }, + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -365721,24 +381171,25 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "assignees" + "subcategory": "issue-dependencies" } } }, - "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { "get": { - "summary": "List issue comments", - "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "summary": "List dependencies an issue is blocking", + "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/list-comments", + "operationId": "issues/list-dependencies-blocking", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" }, "parameters": [ { @@ -365768,16 +381219,6 @@ "type": "integer" } }, - { - "name": "since", - "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, { "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).\"", @@ -365805,13 +381246,11 @@ "schema": { "type": "array", "items": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the issue comment", - "example": 42, "type": "integer", "format": "int64" }, @@ -365819,26 +381258,63 @@ "type": "string" }, "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", "format": "uri" }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" + "repository_url": { + "type": "string", + "format": "uri" }, - "body_text": { + "labels_url": { "type": "string" }, - "body_html": { - "type": "string" + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, "user": { "title": "Simple User", "description": "A GitHub user.", @@ -365964,34 +381440,1517 @@ ], "nullable": true }, - "created_at": { + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { "type": "string", "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" + "format": "date-time" }, - "issue_url": { + "draft": { + "type": "boolean" + }, + "closed_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ], + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { "type": "string", "format": "uri" }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" + "type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "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": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": 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", + "example": 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", + "example": 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", + "example": "\"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" ] }, "performed_via_github_app": { @@ -366303,6 +383262,22 @@ "events" ] }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, "reactions": { "title": "Reaction Rollup", "type": "object", @@ -366351,16 +383326,72 @@ "eyes", "rocket" ] + }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", "id", "node_id", - "html_url", - "issue_url", - "author_association", - "user", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", "url", + "user", + "author_association", "created_at", "updated_at" ] @@ -366371,10 +383402,17 @@ "value": [ { "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", "user": { "login": "octocat", "id": 1, @@ -366395,10 +383433,130 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "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 + }, + "assignees": [ + { + "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 + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "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 + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -366414,6 +383572,32 @@ } } }, + "301": { + "description": "Moved permanently", + "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": { @@ -366471,841 +383655,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "comments" - } - }, - "post": { - "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", - "tags": [ - "issues" - ], - "operationId": "issues/create-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "The contents of the comment." - } - }, - "required": [ - "body" - ] - }, - "examples": { - "default": { - "value": { - "body": "Me too" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" - }, - "body_text": { - "type": "string" - }, - "body_html": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "performed_via_github_app": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "owner": { - "oneOf": [ - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ] - }, - { - "title": "Enterprise", - "description": "An enterprise on GitHub.", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", - "example": 5, - "type": "integer" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDEyOklzc3VlQ29tbWVudDE=", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", - "body": "Me too", - "user": { - "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 - }, - "created_at": "2011-04-14T16:00:49Z", - "updated_at": "2011-04-14T16:00:49Z", - "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "author_association": "COLLABORATOR" - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", - "schema": { - "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" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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" - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "issues", - "subcategory": "comments" + "subcategory": "issue-dependencies" } } }, @@ -380952,6 +397302,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -383414,6 +399788,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -385852,6 +402250,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -388389,6 +404811,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -398933,6 +415379,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -507681,6 +524151,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "type": "string" }, @@ -552363,6 +568857,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -582124,6 +598642,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -585105,6 +601647,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -588088,6 +604654,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -597461,6 +614051,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -600444,6 +617058,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -796344,6 +812982,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -800085,6 +816747,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -803850,6 +820536,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -808021,6 +824731,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -810152,6 +826886,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -814560,6 +831318,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -816691,6 +833473,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -821099,6 +837905,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -823959,6 +840789,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -827638,6 +844492,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -830498,6 +847376,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -833321,6 +850223,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -836211,6 +853137,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -839293,6 +856243,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -842193,6 +859167,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -845266,6 +862264,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -848190,6 +865212,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -851140,6 +868186,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -854016,6 +871086,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -856970,6 +874064,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -858923,6 +876041,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -861801,6 +878943,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -864704,6 +881870,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -867474,6 +884664,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -869443,6 +886657,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -872328,6 +889566,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -875371,6 +892633,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -878256,6 +895542,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -881204,6 +898514,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -884059,6 +901393,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -886943,6 +904301,30 @@ "percent_completed" ] }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -974251,6 +991633,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -975017,6 +992594,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -975783,6 +993555,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -976602,6 +994569,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -981135,6 +999297,201 @@ "url" ], "nullable": true + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -1235931,6 +1254288,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1238791,6 +1257172,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1242467,6 +1260872,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1245327,6 +1263756,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1249003,6 +1267456,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1251863,6 +1270340,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1255539,6 +1274040,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ @@ -1258399,6 +1276924,30 @@ "completed", "percent_completed" ] + }, + "issue_dependencies_summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] } }, "required": [ diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 9e9656c3cf..831bd9057b 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -107,6 +107,8 @@ tags: description: Endpoints to manage campaigns via the REST API. - name: credentials description: Revoke compromised or leaked GitHub credentials. +- name: projects + description: Endpoints to manage Projects using the REST API. servers: - url: https://api.github.com externalDocs: @@ -442,7 +444,7 @@ paths: The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - - &89 + - &91 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For @@ -451,7 +453,7 @@ paths: required: false schema: type: string - - &90 + - &92 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For @@ -460,7 +462,7 @@ paths: required: false schema: type: string - - &91 + - &93 name: direction description: The direction to sort the results by. in: query @@ -681,7 +683,7 @@ paths: required: - vector_string - score - cvss_severities: &105 + cvss_severities: &107 type: object nullable: true properties: @@ -721,7 +723,7 @@ paths: required: - vector_string - score - epss: &106 + epss: &108 type: object nullable: true readOnly: true @@ -859,7 +861,7 @@ paths: - subscriptions_url - type - url - type: &373 + type: &385 type: string description: The type of credit the user is receiving. enum: @@ -992,7 +994,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &208 + schema: &218 title: Validation Error Simple description: Validation Error Simple type: object @@ -1025,7 +1027,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &703 + - &715 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1143,7 +1145,7 @@ paths: GitHub. type: object nullable: true - properties: &165 + properties: &169 id: description: Unique identifier of the GitHub app example: 37 @@ -1276,7 +1278,7 @@ paths: about itself. example: 5 type: integer - required: &166 + required: &170 - id - node_id - owner @@ -1581,7 +1583,7 @@ paths: schema: type: integer default: 30 - - &294 + - &304 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1597,7 +1599,7 @@ paths: application/json: schema: type: array - items: &295 + items: &305 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1677,7 +1679,7 @@ paths: - installation_id - repository_id examples: - default: &296 + default: &306 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1709,7 +1711,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &713 + schema: &725 title: Scim Error description: Scim Error type: object @@ -1736,7 +1738,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &207 + schema: &217 title: Validation Error description: Validation Error type: object @@ -1805,7 +1807,7 @@ paths: description: Response content: application/json: - schema: &297 + schema: &307 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1919,7 +1921,7 @@ paths: - request - response examples: - default: &298 + default: &308 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2120,7 +2122,7 @@ paths: parameters: - *17 - *19 - - &170 + - &174 name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -2698,7 +2700,7 @@ paths: application/json: schema: *22 examples: - default: &74 + default: &76 value: id: 1 account: @@ -2848,11 +2850,11 @@ paths: - selected repositories: type: array - items: &64 + items: &66 title: Repository description: A repository on GitHub. type: object - properties: &353 + properties: &363 id: description: Unique identifier of the repository example: 42 @@ -2872,7 +2874,7 @@ paths: title: License Simple description: License Simple type: object - properties: &181 + properties: &185 key: type: string example: mit @@ -2894,7 +2896,7 @@ paths: html_url: type: string format: uri - required: &182 + required: &186 - key - name - url @@ -3290,7 +3292,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &354 + required: &364 - archive_url - assignees_url - blobs_url @@ -5077,7 +5079,7 @@ paths: responses: '202': *39 '422': *7 - '500': &88 + '500': &90 description: Internal Error content: application/json: @@ -7363,7 +7365,7 @@ paths: description: Response content: application/json: - schema: &209 + schema: &219 type: object properties: total_active_caches_count: @@ -7378,7 +7380,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &210 + default: &220 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7562,7 +7564,7 @@ paths: - public_ip_enabled - platform examples: - default: &211 + default: &221 value: total_count: 2 runners: @@ -7848,7 +7850,7 @@ paths: description: Response content: application/json: - schema: &212 + schema: &222 type: object properties: public_ips: @@ -7873,7 +7875,7 @@ paths: required: - public_ips examples: - default: &213 + default: &223 value: public_ips: current_usage: 17 @@ -7913,7 +7915,7 @@ paths: type: array items: *45 examples: - default: &214 + default: &224 value: id: 4-core cpu_cores: 4 @@ -8170,7 +8172,7 @@ paths: - all - local_only - selected - selected_actions_url: &217 + selected_actions_url: &227 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` @@ -8226,6 +8228,264 @@ paths: githubCloudOnly: true category: actions subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an enterprise + description: Gets artifact and log retention settings for an enterprise. + operationId: enterprise-admin/get-artifact-and-log-retention-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Successfully retrieved the artifact and log retention settings + content: + application/json: + schema: &201 + 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: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '401': &726 + description: Authorization failure + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an enterprise + description: Sets artifact and log retention settings for an enterprise. + operationId: enterprise-admin/set-artifact-and-log-retention-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise + parameters: + - *41 + responses: + '204': + description: Successfully updated the artifact and log retention settings + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: &202 + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + examples: + default: + summary: Set retention to 100 days + value: + days: 100 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an enterprise + description: Gets the fork PR contributor approval policy for an enterprise. + operationId: enterprise-admin/get-fork-pr-contributor-approval-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &50 + 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: &203 + value: + approval_policy: first_time_contributors + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an enterprise + description: Sets the fork PR contributor approval policy for an enterprise. + operationId: enterprise-admin/set-fork-pr-contributor-approval-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise + parameters: + - *41 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *50 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an enterprise + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an enterprise. + operationId: enterprise-admin/get-private-repo-fork-pr-workflows-settings + tags: + - enterprise-admin + 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-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &204 + 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: &51 + 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 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an enterprise + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an enterprise. + operationId: enterprise-admin/set-private-repo-fork-pr-workflows-settings + tags: + - enterprise-admin + 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-enterprise + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: &205 + 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: *51 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions "/enterprises/{enterprise}/actions/permissions/organizations": get: summary: List selected organizations enabled for GitHub Actions in an enterprise @@ -8255,11 +8515,11 @@ paths: type: number organizations: type: array - items: &59 + items: &61 title: Organization Simple description: A GitHub organization. type: object - properties: &101 + properties: &103 login: type: string example: github @@ -8300,7 +8560,7 @@ paths: type: string example: A great organization nullable: true - required: &102 + required: &104 - login - url - id @@ -8317,7 +8577,7 @@ paths: - total_count - organizations examples: - default: &60 + default: &62 value: total_count: 1 organizations: @@ -8396,7 +8656,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - &50 + - &52 name: org_id description: The unique identifier of the organization. in: path @@ -8425,7 +8685,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise parameters: - *41 - - *50 + - *52 responses: '204': description: Response @@ -8454,7 +8714,7 @@ paths: description: Response content: application/json: - schema: &51 + schema: &53 type: object properties: github_owned_allowed: @@ -8475,7 +8735,7 @@ paths: items: type: string examples: - default: &52 + default: &54 value: github_owned_allowed: true verified_allowed: false @@ -8508,14 +8768,91 @@ paths: required: true content: application/json: - schema: *51 + schema: *53 examples: - selected_actions: *52 + selected_actions: *54 x-github: enabledForGitHubApps: false githubCloudOnly: true category: actions subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners permissions for an enterprise + description: Gets the settings for whether organizations in the enterprise are + allowed to manage self-hosted runners at the repository level. + operationId: enterprise-admin/get-self-hosted-runners-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + disable_self_hosted_runners_for_all_orgs: + type: boolean + description: When true, repository-level runners will be disabled + across all organizations in the enterprise + required: + - disable_self_hosted_runners_for_all_orgs + examples: + default: + value: + disable_self_hosted_runners_for_all_orgs: false + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners permissions for an enterprise + description: Sets the settings for whether organizations in the enterprise are + allowed to manage self-hosted runners at the repository level. + operationId: enterprise-admin/set-self-hosted-runners-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise + parameters: + - *41 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + disable_self_hosted_runners_for_all_orgs: + type: boolean + description: When true, repository-level runners will be disabled + across all organizations in the enterprise + required: + - disable_self_hosted_runners_for_all_orgs + examples: + default: + summary: Disable repository-level runners across all organizations + value: + disable_self_hosted_runners_for_all_orgs: true + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions "/enterprises/{enterprise}/actions/permissions/workflow": get: summary: Get default workflow permissions for an enterprise @@ -8538,17 +8875,17 @@ paths: description: Success response content: application/json: - schema: &220 + schema: &230 type: object properties: - default_workflow_permissions: &53 + default_workflow_permissions: &55 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &54 + can_approve_pull_request_reviews: &56 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -8556,7 +8893,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &55 + default: &57 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -8586,13 +8923,13 @@ paths: required: true content: application/json: - schema: &221 + schema: &231 type: object properties: - default_workflow_permissions: *53 - can_approve_pull_request_reviews: *54 + default_workflow_permissions: *55 + can_approve_pull_request_reviews: *56 examples: - default: *55 + default: *57 responses: '204': description: Success response @@ -8637,7 +8974,7 @@ paths: type: number runner_groups: type: array - items: &56 + items: &58 type: object properties: id: @@ -8816,9 +9153,9 @@ paths: description: Response content: application/json: - schema: *56 + schema: *58 examples: - default: &57 + default: &59 value: id: 2 name: octo-runner-group @@ -8853,7 +9190,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - &58 + - &60 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -8865,9 +9202,9 @@ paths: description: Response content: application/json: - schema: *56 + schema: *58 examples: - default: *57 + default: *59 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -8887,7 +9224,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise parameters: - *41 - - *58 + - *60 requestBody: required: false content: @@ -8939,7 +9276,7 @@ paths: description: Response content: application/json: - schema: *56 + schema: *58 examples: default: value: @@ -8975,7 +9312,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise parameters: - *41 - - *58 + - *60 responses: '204': description: Response @@ -8999,7 +9336,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *58 + - *60 - *17 - *19 responses: @@ -9014,12 +9351,12 @@ paths: type: number organizations: type: array - items: *59 + items: *61 required: - total_count - organizations examples: - default: *60 + default: *62 x-github: enabledForGitHubApps: false githubCloudOnly: true @@ -9039,7 +9376,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *58 + - *60 requestBody: required: true content: @@ -9085,8 +9422,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *58 - - *50 + - *60 + - *52 responses: '204': description: Response @@ -9109,8 +9446,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise parameters: - *41 - - *58 - - *50 + - *60 + - *52 responses: '204': description: Response @@ -9134,7 +9471,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *58 + - *60 - *17 - *19 responses: @@ -9149,7 +9486,7 @@ paths: type: number runners: type: array - items: &62 + items: &64 title: Self hosted runners description: A self hosted runner type: object @@ -9178,7 +9515,7 @@ paths: type: boolean labels: type: array - items: &66 + items: &68 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -9211,7 +9548,7 @@ paths: - total_count - runners examples: - default: &63 + default: &65 value: total_count: 2 runners: @@ -9271,7 +9608,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise parameters: - *41 - - *58 + - *60 requestBody: required: true content: @@ -9316,8 +9653,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise parameters: - *41 - - *58 - - &61 + - *60 + - &63 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -9346,8 +9683,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise parameters: - *41 - - *58 - - *61 + - *60 + - *63 responses: '204': description: Response @@ -9390,9 +9727,9 @@ paths: type: number runners: type: array - items: *62 + items: *64 examples: - default: *63 + default: *65 headers: Link: *40 x-github: @@ -9422,7 +9759,7 @@ paths: application/json: schema: type: array - items: &225 + items: &235 title: Runner Application description: Runner Application type: object @@ -9447,7 +9784,7 @@ paths: - download_url - filename examples: - default: &226 + default: &236 value: - os: osx architecture: x64 @@ -9531,7 +9868,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &227 + '201': &237 description: Response content: application/json: @@ -9541,7 +9878,7 @@ paths: - runner - encoded_jit_config properties: - runner: *62 + runner: *64 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -9570,7 +9907,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': &99 + '409': &101 description: Conflict content: application/json: @@ -9608,7 +9945,7 @@ paths: description: Response content: application/json: - schema: &65 + schema: &67 title: Authentication Token description: Authentication Token type: object @@ -9630,7 +9967,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *64 + items: *66 single_file: type: string example: config.yaml @@ -9646,7 +9983,7 @@ paths: - token - expires_at examples: - default: &228 + default: &238 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -9684,9 +10021,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *67 examples: - default: &229 + default: &239 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -9710,15 +10047,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 + - *63 responses: '200': description: Response content: application/json: - schema: *62 + schema: *64 examples: - default: &230 + default: &240 value: id: 23 name: MBP @@ -9758,7 +10095,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise parameters: - *41 - - *61 + - *63 responses: '204': description: Response @@ -9783,9 +10120,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 + - *63 responses: - '200': &67 + '200': &69 description: Response content: application/json: @@ -9799,7 +10136,7 @@ paths: type: integer labels: type: array - items: *66 + items: *68 examples: default: value: @@ -9837,7 +10174,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 + - *63 requestBody: required: true content: @@ -9861,7 +10198,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -9884,7 +10221,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 + - *63 requestBody: required: true content: @@ -9909,7 +10246,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -9932,9 +10269,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 + - *63 responses: - '200': &231 + '200': &241 description: Response content: application/json: @@ -9948,7 +10285,7 @@ paths: type: integer labels: type: array - items: *66 + items: *68 examples: default: value: @@ -9989,8 +10326,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise parameters: - *41 - - *61 - - &232 + - *63 + - &242 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9998,7 +10335,7 @@ paths: schema: type: string responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -10023,20 +10360,20 @@ paths: description: Response content: application/json: - schema: &72 + schema: &74 title: Announcement Banner description: Announcement at either the repository, organization, or enterprise level type: object properties: - announcement: &68 + announcement: &70 type: string description: The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." example: Very **important** announcement about _something_. nullable: true - expires_at: &69 + expires_at: &71 type: string format: date-time description: 'The time at which the announcement expires. This @@ -10046,7 +10383,7 @@ paths: it to an empty string.' example: '"2021-01-01T00:00:00.000-07:00"' nullable: true - user_dismissible: &70 + user_dismissible: &72 type: boolean description: Whether an announcement can be dismissed by the user. example: false @@ -10057,7 +10394,7 @@ paths: - expires_at - user_dismissible examples: - default: &71 + default: &73 summary: Announcement banner value: announcement: Very **important** announcement about _something_. @@ -10081,18 +10418,18 @@ paths: required: true content: application/json: - schema: &239 + schema: &249 title: Enterprise Announcement description: Enterprise global announcement type: object properties: - announcement: *68 - expires_at: *69 - user_dismissible: *70 + announcement: *70 + expires_at: *71 + user_dismissible: *72 required: - announcement examples: - default: *71 + default: *73 parameters: - *41 responses: @@ -10100,9 +10437,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *74 examples: - default: *71 + default: *73 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -10198,7 +10535,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-repositories-belonging-to-an-enterprise-owned-organization parameters: - *41 - - &73 + - &75 name: org description: The organization name. The name is not case sensitive. in: path @@ -10215,7 +10552,7 @@ paths: application/json: schema: type: array - items: &75 + items: &77 title: Accessible Repository description: A repository that may be made accessible to a GitHub App. @@ -10266,7 +10603,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#list-github-apps-installed-on-an-enterprise-owned-organization parameters: - *41 - - *73 + - *75 - *17 - *19 responses: @@ -10361,7 +10698,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#install-a-github-app-on-an-enterprise-owned-organization parameters: - *41 - - *73 + - *75 responses: '200': description: A GitHub App installation that was installed previously. @@ -10369,14 +10706,14 @@ paths: application/json: schema: *22 examples: - default: *74 + default: *76 '201': description: A GitHub App installation. content: application/json: schema: *22 examples: - default: *74 + default: *76 requestBody: required: true content: @@ -10444,7 +10781,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#uninstall-a-github-app-from-an-enterprise-owned-organization parameters: - *41 - - *73 + - *75 - *23 responses: '204': @@ -10472,7 +10809,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#get-the-repositories-accessible-to-a-given-github-app-installation parameters: - *41 - - *73 + - *75 - *23 - *17 - *19 @@ -10484,7 +10821,7 @@ paths: application/json: schema: type: array - items: *75 + items: *77 examples: default: value: @@ -10513,7 +10850,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#toggle-installation-repository-access-between-selected-and-all-repositories parameters: - *41 - - *73 + - *75 - *23 requestBody: required: true @@ -10553,7 +10890,7 @@ paths: application/json: schema: *22 examples: - default: *74 + default: *76 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -10574,7 +10911,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#grant-repository-access-to-an-organization-installation parameters: - *41 - - *73 + - *75 - *23 responses: '200': @@ -10584,7 +10921,7 @@ paths: application/json: schema: type: array - items: *75 + items: *77 examples: default: value: @@ -10635,7 +10972,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/organization-installations#remove-repository-access-from-an-organization-installation parameters: - *41 - - *73 + - *75 - *23 responses: '200': @@ -10645,7 +10982,7 @@ paths: application/json: schema: type: array - items: *75 + items: *77 examples: default: value: @@ -10722,7 +11059,7 @@ paths: required: false schema: type: string - - &240 + - &250 name: include description: |- The event types to include: @@ -10740,7 +11077,7 @@ paths: - web - git - all - - &241 + - &251 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. @@ -10748,7 +11085,7 @@ paths: required: false schema: type: string - - &242 + - &252 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. @@ -10756,7 +11093,7 @@ paths: required: false schema: type: string - - &243 + - &253 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -10778,7 +11115,7 @@ paths: application/json: schema: type: array - items: &244 + items: &254 type: object properties: "@timestamp": @@ -10900,7 +11237,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &245 + default: &255 value: - "@timestamp": 1606929874512 action: team.add_member @@ -11079,7 +11416,7 @@ paths: vendor_specific: type: object oneOf: - - &79 + - &81 title: AzureBlobConfig description: Azure Blob Config for audit log streaming configuration. type: object @@ -11093,7 +11430,7 @@ paths: required: - key_id - encrypted_sas_url - - &80 + - &82 title: AzureHubConfig description: Azure Event Hubs Config for audit log streaming configuration. type: object @@ -11112,7 +11449,7 @@ paths: - name - encrypted_connstring - key_id - - &81 + - &83 title: AmazonS3OIDCConfig description: Amazon S3 OIDC Config for audit log streaming configuration. type: object @@ -11140,7 +11477,7 @@ paths: - bucket - key_id - region - - &82 + - &84 title: AmazonS3AccessKeysConfig description: Amazon S3 Access Keys Config for audit log streaming configuration. @@ -11174,7 +11511,7 @@ paths: - encrypted_secret_key - key_id - region - - &83 + - &85 title: SplunkConfig description: Splunk Config for Audit Log Stream Configuration type: object @@ -11202,7 +11539,7 @@ paths: - key_id - port - ssl_verify - - &84 + - &86 title: HecConfig description: Hec Config for Audit Log Stream Configuration type: object @@ -11234,7 +11571,7 @@ paths: - key_id - port - ssl_verify - - &85 + - &87 title: GoogleCloudConfig description: Google Cloud Config for audit log streaming configuration. type: object @@ -11252,7 +11589,7 @@ paths: - bucket - key_id - encrypted_json_credentials - - &86 + - &88 title: DatadogConfig description: Datadog Config for audit log streaming configuration. type: object @@ -11283,7 +11620,7 @@ paths: - stream_type - vendor_specific examples: - default: &87 + default: &89 value: enabled: false stream_type: Azure Event Hubs @@ -11297,7 +11634,7 @@ paths: description: The audit log stream configuration was created successfully. content: application/json: - schema: &76 + schema: &78 title: Get an audit log streaming configuration description: Get an audit log streaming configuration for an enterprise. type: object @@ -11328,7 +11665,7 @@ paths: - created_at - updated_at examples: - default: &77 + default: &79 value: id: 1 stream_type: Splunk @@ -11357,7 +11694,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id parameters: - *41 - - &78 + - &80 name: stream_id description: The ID of the audit log stream configuration. in: path @@ -11369,9 +11706,9 @@ paths: description: Lists one audit log stream configuration via stream ID. content: application/json: - schema: *76 + schema: *78 examples: - default: *77 + default: *79 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -11391,7 +11728,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration parameters: - *41 - - *78 + - *80 requestBody: required: true content: @@ -11417,28 +11754,28 @@ paths: vendor_specific: type: object oneOf: - - *79 - - *80 - *81 - *82 - *83 - *84 - *85 - *86 + - *87 + - *88 required: - enabled - stream_type - vendor_specific examples: - default: *87 + default: *89 responses: '200': description: Successful update content: application/json: - schema: *76 + schema: *78 examples: - default: *77 + default: *79 '422': description: Validation error content: @@ -11469,7 +11806,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise parameters: - *41 - - *78 + - *80 responses: '204': description: The audit log stream configuration was deleted successfully. @@ -11501,7 +11838,7 @@ paths: in: query schema: type: string - - &247 + - &257 name: reviewer description: Filter bypass requests by the handle of the GitHub user who reviewed the bypass request. @@ -11509,7 +11846,7 @@ paths: required: false schema: type: string - - &248 + - &258 name: requester description: Filter bypass requests by the handle of the GitHub user who requested the bypass. @@ -11517,7 +11854,7 @@ paths: required: false schema: type: string - - &249 + - &259 name: time_period description: |- The time period to filter by. @@ -11533,7 +11870,7 @@ paths: - week - month default: day - - &250 + - &260 name: request_status description: The status of the bypass request to filter on. When specified, only requests with this status will be returned. @@ -11560,7 +11897,7 @@ paths: application/json: schema: type: array - items: &251 + items: &261 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -11677,7 +12014,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: &254 + items: &264 title: Bypass response description: A response made by a delegated bypasser to a bypass request. @@ -11721,7 +12058,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &252 + default: &262 value: - id: 21 number: 42 @@ -11790,7 +12127,7 @@ paths: url: https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2 html_url: https://github.com/octo-org/smile/exemptions/2 '404': *6 - '500': *88 + '500': *90 "/enterprises/{enterprise}/code-scanning/alerts": get: summary: List code scanning alerts for an enterprise @@ -11808,17 +12145,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *41 - - &259 + - &269 name: tool_name description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. in: query required: false - schema: &92 + schema: &94 type: string description: The name of the tool used to generate the code scanning analysis. - - &260 + - &270 name: tool_guid description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in @@ -11826,22 +12163,22 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &93 + schema: &95 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *89 - - *90 + - *91 + - *92 - *19 - *17 - - *91 + - *93 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &261 + schema: &271 type: string description: State of a code scanning alert. enum: @@ -11866,42 +12203,42 @@ paths: application/json: schema: type: array - items: &262 + items: &272 type: object properties: - number: &103 + number: &105 type: integer description: The security alert number. readOnly: true - created_at: &110 + created_at: &112 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &111 + updated_at: &113 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - url: &108 + url: &110 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &109 + html_url: &111 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &490 + instances_url: &502 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &94 + state: &96 type: string description: State of a code scanning alert. nullable: true @@ -11909,7 +12246,7 @@ paths: - open - dismissed - fixed - fixed_at: &113 + fixed_at: &115 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -11923,14 +12260,14 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: &112 + dismissed_at: &114 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - dismissed_reason: &491 + dismissed_reason: &503 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -11939,13 +12276,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &492 + dismissed_comment: &504 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &493 + rule: &505 type: object properties: id: @@ -11998,25 +12335,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &494 + tool: &506 type: object properties: - name: *92 + name: *94 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *93 - most_recent_instance: &495 + guid: *95 + most_recent_instance: &507 type: object properties: - ref: &488 + ref: &500 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &505 + analysis_key: &517 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -12027,13 +12364,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &506 + category: &518 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. - state: *94 + state: *96 commit_sha: type: string message: @@ -12072,11 +12409,11 @@ paths: - generated - test - library - repository: &100 + repository: &102 title: Simple Repository description: A GitHub repository. type: object - properties: &197 + properties: &207 id: type: integer format: int64 @@ -12303,7 +12640,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &198 + required: &208 - archive_url - assignees_url - blobs_url @@ -12372,7 +12709,7 @@ paths: - most_recent_instance - repository examples: - default: &263 + default: &273 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -12603,7 +12940,7 @@ paths: headers: Link: *40 '404': *6 - '503': &157 + '503': &159 description: Service unavailable content: application/json: @@ -12647,8 +12984,8 @@ paths: schema: type: integer default: 30 - - *89 - - *90 + - *91 + - *92 responses: '200': description: Response @@ -12656,7 +12993,7 @@ paths: application/json: schema: type: array - items: &95 + items: &97 type: object description: A code security configuration properties: @@ -13025,7 +13362,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &264 + code_scanning_options: &274 type: object description: Security Configuration feature options for code scanning nullable: true @@ -13042,7 +13379,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &98 + code_scanning_default_setup_options: &100 type: object description: Feature options for code scanning default setup nullable: true @@ -13159,9 +13496,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *95 + schema: *97 examples: - default: &96 + default: &98 value: id: 1325 target_type: enterprise @@ -13219,7 +13556,7 @@ paths: description: Response content: application/json: - schema: &266 + schema: &276 type: array description: A list of default code security configurations items: @@ -13233,9 +13570,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *95 + configuration: *97 examples: - default: &267 + default: &277 value: - default_for_new_repos: public configuration: @@ -13324,7 +13661,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - *41 - - &97 + - &99 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -13336,9 +13673,9 @@ paths: description: Response content: application/json: - schema: *95 + schema: *97 examples: - default: *96 + default: *98 '304': *37 '403': *29 '404': *6 @@ -13363,7 +13700,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - *41 - - *97 + - *99 requestBody: required: true content: @@ -13442,7 +13779,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *98 + code_scanning_default_setup_options: *100 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -13530,13 +13867,13 @@ paths: description: Response content: application/json: - schema: *95 + schema: *97 examples: - default: *96 + default: *98 '304': *37 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13560,14 +13897,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - *41 - - *97 + - *99 responses: - '204': &123 + '204': &125 description: A header with no content is returned. '400': *14 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13592,7 +13929,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - *41 - - *97 + - *99 requestBody: required: true content: @@ -13619,7 +13956,7 @@ paths: '202': *39 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13644,7 +13981,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - *41 - - *97 + - *99 requestBody: required: true content: @@ -13684,12 +14021,12 @@ paths: - none - private_and_internal - public - configuration: *95 + configuration: *97 examples: default: value: default_for_new_repos: all - configuration: &265 + configuration: &275 value: id: 1325 target_type: organization @@ -13746,7 +14083,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - *41 - - *97 + - *99 - 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)." @@ -13755,8 +14092,8 @@ paths: schema: type: integer default: 30 - - *89 - - *90 + - *91 + - *92 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -13774,7 +14111,7 @@ paths: application/json: schema: type: array - items: &268 + items: &278 type: object description: Repositories associated with a code security configuration and attachment status @@ -13792,13 +14129,13 @@ paths: - failed - updating - removed_by_enterprise - repository: *100 + repository: *102 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: &269 + repository: &279 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -14227,7 +14564,7 @@ paths: For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -14263,7 +14600,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &114 + items: &116 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -14280,14 +14617,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *101 - required: *102 + properties: *103 + required: *104 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &255 + - &265 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -14346,7 +14683,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &331 + properties: &341 id: description: Unique identifier of the team type: integer @@ -14402,7 +14739,7 @@ paths: maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &332 + required: &342 - id - node_id - url @@ -14524,7 +14861,7 @@ paths: - created_at additionalProperties: false examples: - default: &115 + default: &117 value: total_seats: 2 seats: @@ -14593,7 +14930,7 @@ paths: site_admin: false headers: Link: *40 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -14655,7 +14992,7 @@ paths: application/json: schema: type: array - items: &161 + items: &165 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -14962,7 +15299,7 @@ paths: - date additionalProperties: true examples: - default: &162 + default: &166 value: - date: '2024-06-24' total_active_users: 24 @@ -15061,10 +15398,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *88 + '500': *90 '403': *29 '404': *6 - '422': &163 + '422': &167 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -15094,7 +15431,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *41 - - &276 + - &286 name: state in: query description: |- @@ -15103,7 +15440,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &277 + - &287 name: severity in: query description: |- @@ -15112,7 +15449,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &278 + - &288 name: ecosystem in: query description: |- @@ -15121,14 +15458,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &279 + - &289 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &280 + - &290 name: epss_percentage in: query description: |- @@ -15140,7 +15477,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &281 + - &291 name: has in: query description: |- @@ -15154,7 +15491,7 @@ paths: type: string enum: - patch - - &282 + - &292 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -15164,7 +15501,7 @@ paths: enum: - development - runtime - - &283 + - &293 name: sort in: query description: |- @@ -15179,10 +15516,10 @@ paths: - updated - epss_percentage default: created + - *93 - *91 - - *89 - - *90 - - &284 + - *92 + - &294 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -15195,7 +15532,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &285 + - &295 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -15215,11 +15552,11 @@ paths: application/json: schema: type: array - items: &286 + items: &296 type: object description: A Dependabot alert. properties: - number: *103 + number: *105 state: type: string description: The state of the Dependabot alert. @@ -15234,7 +15571,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &104 + package: &106 type: object description: Details for the vulnerable package. readOnly: true @@ -15278,7 +15615,7 @@ paths: - unknown - direct - transitive - security_advisory: &547 + security_advisory: &559 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -15308,13 +15645,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &107 + items: &109 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *104 + package: *106 severity: type: string description: The severity of the vulnerability. @@ -15380,8 +15717,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *105 - epss: *106 + cvss_severities: *107 + epss: *108 cwes: type: array description: Details for the advisory pertaining to Common @@ -15480,12 +15817,12 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *107 - url: *108 - html_url: *109 - created_at: *110 - updated_at: *111 - dismissed_at: *112 + security_vulnerability: *109 + url: *110 + html_url: *111 + created_at: *112 + updated_at: *113 + dismissed_at: *114 dismissed_by: title: Simple User description: A GitHub user. @@ -15509,15 +15846,15 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *113 - auto_dismissed_at: &548 + fixed_at: *115 + auto_dismissed_at: &560 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - repository: *100 + repository: *102 required: - number - state @@ -15536,7 +15873,7 @@ paths: - repository additionalProperties: false examples: - default: &287 + default: &297 value: - number: 2 state: dismissed @@ -15953,7 +16290,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-an-enterprise-user parameters: - *41 - - &246 + - &256 name: username description: The handle for the GitHub user account. in: path @@ -15975,10 +16312,10 @@ paths: teams or multiple organizations are only counted once. seats: type: array - items: *114 + items: *116 examples: - default: *115 - '500': *88 + default: *117 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -16020,7 +16357,7 @@ paths: type: integer network_configurations: type: array - items: &116 + items: &118 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -16060,7 +16397,7 @@ paths: - name - created_on examples: - default: &384 + default: &396 value: total_count: 2 network_configurations: @@ -16138,9 +16475,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: &117 + default: &119 value: id: 123456789ABCDEF name: My network configuration @@ -16167,7 +16504,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - &118 + - &120 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -16179,9 +16516,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: *117 + default: *119 headers: Link: *40 x-github: @@ -16201,7 +16538,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#update-a-hosted-compute-network-configuration-for-an-enterprise parameters: - *41 - - *118 + - *120 requestBody: required: true content: @@ -16240,9 +16577,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: *117 + default: *119 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -16260,7 +16597,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#delete-a-hosted-compute-network-configuration-from-an-enterprise parameters: - *41 - - *118 + - *120 responses: '204': description: Response @@ -16283,7 +16620,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &385 + - &397 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -16295,7 +16632,7 @@ paths: description: Response content: application/json: - schema: &386 + schema: &398 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -16329,7 +16666,7 @@ paths: - subnet_id - region examples: - default: &387 + default: &399 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -16364,7 +16701,7 @@ paths: application/json: schema: type: array - items: &119 + items: &121 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -16430,7 +16767,7 @@ paths: - property_name - value_type examples: - default: &120 + default: &122 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -16487,7 +16824,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *119 + items: *121 minItems: 1 maxItems: 100 required: @@ -16517,9 +16854,9 @@ paths: application/json: schema: type: array - items: *119 + items: *121 examples: - default: *120 + default: *122 '403': *29 '404': *6 x-github: @@ -16542,8 +16879,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#promote-a-custom-property-to-an-enterprise parameters: - *41 - - *73 - - &121 + - *75 + - &123 name: custom_property_name description: The custom property name in: path @@ -16555,9 +16892,9 @@ paths: description: Response content: application/json: - schema: *119 + schema: *121 examples: - default: &122 + default: &124 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -16590,15 +16927,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise parameters: - *41 - - *121 + - *123 responses: '200': description: Response content: application/json: - schema: *119 + schema: *121 examples: - default: *122 + default: *124 '403': *29 '404': *6 x-github: @@ -16620,12 +16957,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise parameters: - *41 - - *121 + - *123 requestBody: required: true content: application/json: - schema: &351 + schema: &361 title: Custom Property Set Payload description: Custom property set payload type: object @@ -16689,9 +17026,9 @@ paths: description: Response content: application/json: - schema: *119 + schema: *121 examples: - default: *122 + default: *124 '403': *29 '404': *6 x-github: @@ -16713,9 +17050,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise parameters: - *41 - - *121 + - *123 responses: - '204': *123 + '204': *125 '403': *29 '404': *6 x-github: @@ -16755,7 +17092,7 @@ paths: - push - repository default: branch - enforcement: &130 + enforcement: &132 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights @@ -16768,7 +17105,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &131 + items: &133 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -16805,7 +17142,7 @@ paths: - always - pull_request default: always - conditions: &154 + conditions: &156 title: Enterprise ruleset conditions type: object description: Conditions for an enterprise ruleset. The conditions @@ -16819,7 +17156,7 @@ paths: description: Conditions to target organizations by name and all repositories allOf: - - &124 + - &126 title: Repository ruleset conditions for organization names type: object description: Parameters for an organization name condition @@ -16845,7 +17182,7 @@ paths: type: string required: - organization_name - - &127 + - &129 title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -16874,7 +17211,7 @@ paths: is prevented. required: - repository_name - - &126 + - &128 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name condition @@ -16902,8 +17239,8 @@ paths: description: Conditions to target organizations by name and repositories by property allOf: - - *124 - - &129 + - *126 + - &131 title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -16916,7 +17253,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &125 + items: &127 title: Repository ruleset property targeting definition type: object description: Parameters for a targeting a repository @@ -16947,16 +17284,16 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *125 + items: *127 required: - repository_property - - *126 + - *128 - type: object title: organization_id_and_repository_name description: Conditions to target organizations by id and all repositories allOf: - - &128 + - &130 title: Repository ruleset conditions for organization IDs type: object description: Parameters for an organization ID condition @@ -16973,25 +17310,25 @@ paths: type: integer required: - organization_id - - *127 - - *126 + - *129 + - *128 - type: object title: organization_id_and_repository_property description: Conditions to target organization by id and repositories by property allOf: + - *130 + - *131 - *128 - - *129 - - *126 rules: type: array description: An array of rules within the ruleset. - items: &155 + items: &157 title: Repository Rule type: object description: A repository rule. oneOf: - - &132 + - &134 title: creation description: Only allow users with bypass permission to create matching refs. @@ -17003,7 +17340,7 @@ paths: type: string enum: - creation - - &133 + - &135 title: update description: Only allow users with bypass permission to update matching refs. @@ -17024,7 +17361,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &134 + - &136 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -17036,7 +17373,7 @@ paths: type: string enum: - deletion - - &135 + - &137 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -17048,7 +17385,7 @@ paths: type: string enum: - required_linear_history - - &136 + - &138 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches @@ -17072,7 +17409,7 @@ paths: type: string required: - required_deployment_environments - - &137 + - &139 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -17084,7 +17421,7 @@ paths: type: string enum: - required_signatures - - &138 + - &140 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -17144,7 +17481,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &139 + - &141 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed @@ -17191,7 +17528,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &140 + - &142 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -17203,7 +17540,7 @@ paths: type: string enum: - non_fast_forward - - &141 + - &143 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -17239,7 +17576,7 @@ paths: required: - operator - pattern - - &142 + - &144 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -17275,7 +17612,7 @@ paths: required: - operator - pattern - - &143 + - &145 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -17311,7 +17648,7 @@ paths: required: - operator - pattern - - &144 + - &146 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -17347,7 +17684,7 @@ paths: required: - operator - pattern - - &145 + - &147 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -17383,7 +17720,7 @@ paths: required: - operator - pattern - - &146 + - &148 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. @@ -17407,7 +17744,7 @@ paths: type: string required: - restricted_file_paths - - &147 + - &149 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit @@ -17431,7 +17768,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &148 + - &150 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -17454,7 +17791,7 @@ paths: type: string required: - restricted_file_extensions - - &149 + - &151 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. @@ -17478,7 +17815,7 @@ paths: maximum: 100 required: - max_file_size - - &150 + - &152 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -17527,7 +17864,7 @@ paths: - repository_id required: - workflows - - &151 + - &153 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning @@ -17613,7 +17950,7 @@ paths: description: Response content: application/json: - schema: &152 + schema: &154 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -17648,11 +17985,11 @@ paths: source: type: string description: The name of the source - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 + items: *133 current_user_can_bypass: type: string description: |- @@ -17683,8 +18020,8 @@ paths: conditions: nullable: true anyOf: - - *126 - - &358 + - *128 + - &368 title: Organization ruleset conditions type: object description: |- @@ -17698,14 +18035,14 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *126 - - *127 + - *128 + - *129 - type: object title: repository_id_and_ref_name description: Conditions to target repositories by id and refs by name allOf: - - *126 + - *128 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -17727,20 +18064,20 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *126 - - *129 + - *128 + - *131 rules: type: array - items: &669 + items: &681 title: Repository Rule type: object description: A repository rule. oneOf: - - *132 - - *133 - *134 - *135 - - &667 + - *136 + - *137 + - &679 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -17818,8 +18155,6 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - *136 - - *137 - *138 - *139 - *140 @@ -17834,6 +18169,8 @@ paths: - *149 - *150 - *151 + - *152 + - *153 created_at: type: string format: date-time @@ -17841,7 +18178,7 @@ paths: type: string format: date-time examples: - default: &153 + default: &155 value: id: 21 name: super cool ruleset @@ -17867,7 +18204,7 @@ paths: created_at: '2024-08-15T08:43:03Z' updated_at: '2024-09-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -17900,11 +18237,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *153 + default: *155 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -17946,16 +18283,16 @@ paths: - tag - push - repository - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 - conditions: *154 + items: *133 + conditions: *156 rules: description: An array of rules within the ruleset. type: array - items: *155 + items: *157 examples: default: value: @@ -17979,11 +18316,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *153 + default: *155 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -18010,7 +18347,7 @@ paths: '204': description: Response '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -18043,7 +18380,7 @@ paths: application/json: schema: type: array - items: &156 + items: &158 title: Ruleset version type: object description: The historical version of a ruleset @@ -18067,7 +18404,7 @@ paths: type: string format: date-time examples: - default: &361 + default: &371 value: - version_id: 3 actor: @@ -18085,7 +18422,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18120,9 +18457,9 @@ paths: description: Response content: application/json: - schema: &362 + schema: &372 allOf: - - *156 + - *158 - type: object required: - state @@ -18155,7 +18492,7 @@ paths: rules: - type: repository_delete '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -18175,7 +18512,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *41 - - &363 + - &373 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -18186,7 +18523,7 @@ paths: enum: - open - resolved - - &364 + - &374 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -18196,7 +18533,7 @@ paths: required: false schema: type: string - - &365 + - &375 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -18205,7 +18542,7 @@ paths: required: false schema: type: string - - &366 + - &376 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -18217,11 +18554,11 @@ paths: - created - updated default: created - - *91 + - *93 - *17 - - *89 - - *90 - - &367 + - *91 + - *92 + - &377 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -18230,7 +18567,7 @@ paths: required: false schema: type: string - - &368 + - &378 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -18239,7 +18576,7 @@ paths: schema: type: boolean default: false - - &369 + - &379 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -18248,7 +18585,7 @@ paths: schema: type: boolean default: false - - &370 + - &380 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -18264,11 +18601,11 @@ paths: application/json: schema: type: array - items: &371 + items: &381 type: object properties: - number: *103 - created_at: *110 + number: *105 + created_at: *112 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -18276,21 +18613,21 @@ paths: format: date-time readOnly: true nullable: true - url: *108 - html_url: *109 + url: *110 + html_url: *111 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &681 + state: &693 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &682 + resolution: &694 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -18324,7 +18661,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *100 + repository: *102 push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected @@ -18397,8 +18734,8 @@ paths: pull request. ' - oneOf: &683 - - &685 + oneOf: &695 + - &697 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -18450,7 +18787,7 @@ paths: - blob_url - commit_sha - commit_url - - &686 + - &698 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -18505,7 +18842,7 @@ paths: - page_url - commit_sha - commit_url - - &687 + - &699 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -18519,7 +18856,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &688 + - &700 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -18533,7 +18870,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &689 + - &701 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -18547,7 +18884,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &690 + - &702 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -18561,7 +18898,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &691 + - &703 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -18575,7 +18912,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &692 + - &704 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -18589,7 +18926,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &693 + - &705 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -18603,7 +18940,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &694 + - &706 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -18617,7 +18954,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &695 + - &707 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -18631,7 +18968,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &696 + - &708 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -18645,7 +18982,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &697 + - &709 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -18665,7 +19002,7 @@ paths: description: A boolean value representing whether or not the token in the alert was detected in more than one location. examples: - default: &372 + default: &382 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -18916,12 +19253,239 @@ paths: headers: Link: *40 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/secret-scanning/pattern-configurations": + get: + summary: List enterprise pattern configurations + description: |- + Lists the secret scanning pattern configurations for an enterprise. + + Personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-enterprise-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *41 + responses: + '200': + description: Response + content: + application/json: + schema: &383 + title: Secret scanning pattern configuration + description: A collection of secret scanning patterns and their settings + related to push protection. + type: object + properties: + pattern_config_version: &161 + type: string + description: The version of the entity. This is used to confirm + you're updating the current version of the entity and mitigate + unintentionally overriding someone else's update. + nullable: true + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: &160 + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: string + description: The version of this pattern if it's a custom + pattern. + nullable: true + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this + pattern. + alert_total_percentage: + type: integer + description: The percentage of all alerts that this pattern + represents, rounded to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated + by this pattern. + false_positive_rate: + type: integer + description: The percentage of alerts from this pattern + that are false positives, rounded to the nearest integer. + bypass_rate: + type: integer + description: The percentage of blocks for this pattern that + were bypassed, rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this + pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: string + description: The push protection setting for this pattern + set at the enterprise level. Only present for partner + patterns when the organization has a parent enterprise. + enum: + - not-set + - disabled + - enabled + nullable: true + setting: + type: string + description: The current push protection setting for this + pattern. If this is `not-set`, then it inherits either + the enterprise setting if it exists or the default setting. + enum: + - not-set + - disabled + - enabled + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: *160 + examples: + default: &384 + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled + '403': *29 + '404': *6 + patch: + summary: Update enterprise pattern configurations + description: |- + Updates the secret scanning pattern configurations for an enterprise. + + Personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-enterprise-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *41 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: *161 + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: *161 + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': *14 + '403': *29 + '404': *6 + '409': *101 + '422': *15 "/enterprises/{enterprise}/settings/billing/actions": get: summary: Get GitHub Actions billing for an enterprise @@ -18947,7 +19511,7 @@ paths: description: Response content: application/json: - schema: &375 + schema: &387 type: object properties: total_minutes_used: @@ -19017,7 +19581,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &376 + default: &388 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -19048,7 +19612,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &377 + - &389 name: advanced_security_product in: query description: | @@ -19068,7 +19632,7 @@ paths: description: Success content: application/json: - schema: &378 + schema: &390 type: object properties: total_advanced_security_committers: @@ -19123,7 +19687,7 @@ paths: required: - repositories examples: - default: &379 + default: &391 value: total_advanced_security_committers: 2 total_count: 2 @@ -19219,8 +19783,8 @@ paths: name: octocat/hello-world '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19338,7 +19902,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - *41 - - &160 + - &164 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -19350,7 +19914,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &158 + schema: &162 type: object properties: id: @@ -19378,7 +19942,7 @@ paths: - name - resources examples: - default: &159 + default: &163 value: - id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -19389,8 +19953,8 @@ paths: name: octocat/hello-world '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19440,15 +20004,15 @@ paths: description: Response when updating a cost center content: application/json: - schema: *158 + schema: *162 examples: - default: *159 + default: *163 '400': *14 '403': *29 '404': *6 - '409': *99 - '500': *88 - '503': *157 + '409': *101 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19466,7 +20030,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - *41 - - *160 + - *164 responses: '200': description: Response when deleting a cost center @@ -19504,8 +20068,8 @@ paths: '400': *14 '404': *6 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19526,7 +20090,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - *41 - - *160 + - *164 requestBody: required: true content: @@ -19571,9 +20135,9 @@ paths: message: Resources successfully added to the cost center. '400': *14 '403': *29 - '409': *99 - '500': *88 - '503': *157 + '409': *101 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19593,7 +20157,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - *41 - - *160 + - *164 requestBody: required: true content: @@ -19639,8 +20203,8 @@ paths: message: Resources successfully removed from the cost center. '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19671,7 +20235,7 @@ paths: description: Response content: application/json: - schema: &380 + schema: &392 type: object properties: total_gigabytes_bandwidth_used: @@ -19689,7 +20253,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &381 + default: &393 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -19724,7 +20288,7 @@ paths: description: Response content: application/json: - schema: &382 + schema: &394 type: object properties: days_left_in_billing_cycle: @@ -19742,7 +20306,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &383 + default: &395 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -19767,7 +20331,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *41 - - &199 + - &209 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, @@ -19776,7 +20340,7 @@ paths: required: false schema: type: integer - - &200 + - &210 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 @@ -19785,7 +20349,7 @@ paths: required: false schema: type: integer - - &201 + - &211 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 @@ -19794,7 +20358,7 @@ paths: required: false schema: type: integer - - &202 + - &212 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 @@ -19815,7 +20379,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &203 + schema: &213 type: object properties: usageItems: @@ -19868,7 +20432,7 @@ paths: - netAmount - organizationName examples: - default: &204 + default: &214 value: usageItems: - date: '2023-08-01' @@ -19884,8 +20448,8 @@ paths: repositoryName: github/example '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -19956,13 +20520,13 @@ paths: application/json: schema: type: array - items: *161 + items: *165 examples: - default: *162 - '500': *88 + default: *166 + '500': *90 '403': *29 '404': *6 - '422': *163 + '422': *167 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -20051,7 +20615,7 @@ paths: application/json: schema: type: array - items: &192 + items: &196 title: Event description: Event type: object @@ -20061,7 +20625,7 @@ paths: type: type: string nullable: true - actor: &164 + actor: &168 title: Actor description: Actor type: object @@ -20101,18 +20665,18 @@ paths: - id - name - url - org: *164 + org: *168 payload: type: object properties: action: type: string - issue: &180 + issue: &184 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &605 + properties: &617 id: type: integer format: int64 @@ -20224,7 +20788,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &532 + properties: &544 url: type: string format: uri @@ -20294,7 +20858,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &533 + required: &545 - closed_issues - creator - description @@ -20373,7 +20937,7 @@ paths: timeline_url: type: string format: uri - type: &316 + type: &326 title: Issue Type description: The type of issue. type: object @@ -20422,7 +20986,7 @@ paths: - node_id - name - description - repository: *64 + repository: *66 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -20432,9 +20996,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 - author_association: &167 + properties: *169 + required: *170 + author_association: &171 title: author_association type: string example: OWNER @@ -20448,7 +21012,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &168 + reactions: &172 title: Reaction Rollup type: object properties: @@ -20484,7 +21048,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &741 + sub_issues_summary: &753 title: Sub-issues Summary type: object properties: @@ -20498,7 +21062,24 @@ paths: - total - completed - percent_completed - required: &606 + issue_dependencies_summary: &754 + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + required: &618 - assignee - closed_at - comments @@ -20520,7 +21101,7 @@ paths: - author_association - created_at - updated_at - comment: &603 + comment: &615 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -20568,7 +21149,7 @@ paths: issue_url: type: string format: uri - author_association: *167 + author_association: *171 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -20578,9 +21159,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 - reactions: *168 + properties: *169 + required: *170 + reactions: *172 required: - id - node_id @@ -20675,7 +21256,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20756,7 +21337,7 @@ paths: _links: type: object properties: - timeline: &169 + timeline: &173 title: Link With Type description: Hypermedia Link with Type type: object @@ -20768,17 +21349,17 @@ paths: required: - href - type - user: *169 - security_advisories: *169 - current_user: *169 - current_user_public: *169 - current_user_actor: *169 - current_user_organization: *169 + user: *173 + security_advisories: *173 + current_user: *173 + current_user_public: *173 + current_user_actor: *173 + current_user_organization: *173 current_user_organizations: type: array - items: *169 - repository_discussions: *169 - repository_discussions_category: *169 + items: *173 + repository_discussions: *173 + repository_discussions_category: *173 required: - timeline - user @@ -20840,7 +21421,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *170 + - *174 - *17 - *19 responses: @@ -20850,7 +21431,7 @@ paths: application/json: schema: type: array - items: &171 + items: &175 title: Base Gist description: Base Gist type: object @@ -20949,7 +21530,7 @@ paths: - created_at - updated_at examples: - default: &172 + default: &176 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -21070,7 +21651,7 @@ paths: description: Response content: application/json: - schema: &173 + schema: &177 title: Gist Simple description: Gist Simple type: object @@ -21087,7 +21668,7 @@ paths: url: type: string format: uri - user: &753 + user: &766 title: Public User description: Public User type: object @@ -21449,7 +22030,7 @@ paths: truncated: type: boolean examples: - default: &174 + default: &178 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -21553,7 +22134,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *170 + - *174 - *17 - *19 responses: @@ -21563,9 +22144,9 @@ paths: application/json: schema: type: array - items: *171 + items: *175 examples: - default: *172 + default: *176 headers: Link: *40 '422': *15 @@ -21587,7 +22168,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *170 + - *174 - *17 - *19 responses: @@ -21597,9 +22178,9 @@ paths: application/json: schema: type: array - items: *171 + items: *175 examples: - default: *172 + default: *176 headers: Link: *40 '401': *25 @@ -21627,7 +22208,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &175 + - &179 name: gist_id description: The unique identifier of the gist. in: path @@ -21639,10 +22220,10 @@ paths: description: Response content: application/json: - schema: *173 + schema: *177 examples: - default: *174 - '403': &178 + default: *178 + '403': &182 description: Forbidden Gist content: application/json: @@ -21690,7 +22271,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *175 + - *179 requestBody: required: true content: @@ -21750,9 +22331,9 @@ paths: description: Response content: application/json: - schema: *173 + schema: *177 examples: - updateGist: *174 + updateGist: *178 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -21910,7 +22491,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *175 + - *179 responses: '204': description: Response @@ -21939,7 +22520,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *175 + - *179 - *17 - *19 responses: @@ -21949,7 +22530,7 @@ paths: application/json: schema: type: array - items: &176 + items: &180 title: Gist Comment description: A comment made to a gist. type: object @@ -21984,7 +22565,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *167 + author_association: *171 required: - url - id @@ -22049,7 +22630,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *175 + - *179 requestBody: required: true content: @@ -22074,9 +22655,9 @@ paths: description: Response content: application/json: - schema: *176 + schema: *180 examples: - default: &177 + default: &181 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -22134,8 +22715,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *175 - - &179 + - *179 + - &183 name: comment_id description: The unique identifier of the comment. in: path @@ -22148,12 +22729,12 @@ paths: description: Response content: application/json: - schema: *176 + schema: *180 examples: - default: *177 + default: *181 '304': *37 '404': *6 - '403': *178 + '403': *182 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22175,8 +22756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *175 - *179 + - *183 requestBody: required: true content: @@ -22201,9 +22782,9 @@ paths: description: Response content: application/json: - schema: *176 + schema: *180 examples: - default: *177 + default: *181 '404': *6 x-github: githubCloudOnly: false @@ -22220,8 +22801,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *175 - *179 + - *183 responses: '204': description: Response @@ -22244,7 +22825,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *175 + - *179 - *17 - *19 responses: @@ -22345,7 +22926,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *175 + - *179 - *17 - *19 responses: @@ -22355,7 +22936,7 @@ paths: application/json: schema: type: array - items: *173 + items: *177 examples: default: value: @@ -22420,13 +23001,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *175 + - *179 responses: '201': description: Response content: application/json: - schema: *171 + schema: *175 examples: default: value: @@ -22497,7 +23078,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *175 + - *179 responses: '204': description: Response if gist is starred @@ -22527,7 +23108,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *175 + - *179 responses: '204': description: Response @@ -22549,7 +23130,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *175 + - *179 responses: '204': description: Response @@ -22578,7 +23159,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *175 + - *179 - name: sha in: path required: true @@ -22589,9 +23170,9 @@ paths: description: Response content: application/json: - schema: *173 + schema: *177 examples: - default: *174 + default: *178 '422': *15 '404': *6 '403': *29 @@ -22750,7 +23331,7 @@ paths: type: integer repositories: type: array - items: *64 + items: *66 repository_selection: type: string example: selected @@ -22957,7 +23538,7 @@ paths: - closed - all default: open - - &319 + - &329 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -22975,8 +23556,8 @@ paths: - updated - comments default: created - - *91 - - *170 + - *93 + - *174 - name: collab in: query required: false @@ -23006,9 +23587,9 @@ paths: application/json: schema: type: array - items: *180 + items: *184 examples: - default: &320 + default: &330 value: - id: 1 node_id: MDU6SXNzdWUx @@ -23292,8 +23873,8 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 examples: default: value: @@ -23578,7 +24159,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &183 + X-CommonMarker-Version: &187 example: 0.17.4 schema: type: string @@ -23633,7 +24214,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *183 + X-CommonMarker-Version: *187 content: text/html: schema: @@ -23662,7 +24243,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &186 + - &190 name: account_id description: account_id parameter in: path @@ -23674,7 +24255,7 @@ paths: description: Response content: application/json: - schema: &185 + schema: &189 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -23704,7 +24285,7 @@ paths: nullable: true id: type: integer - plan: &184 + plan: &188 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -23793,7 +24374,7 @@ paths: nullable: true updated_at: type: string - plan: *184 + plan: *188 required: - url - id @@ -23801,7 +24382,7 @@ paths: - login - marketplace_purchase examples: - default: &187 + default: &191 value: url: https://api.github.com/orgs/github type: Organization @@ -23886,9 +24467,9 @@ paths: application/json: schema: type: array - items: *184 + items: *188 examples: - default: &188 + default: &192 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -23928,14 +24509,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &189 + - &193 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &190 + - &194 name: sort description: The property to sort the results by. in: query @@ -23965,9 +24546,9 @@ paths: application/json: schema: type: array - items: *185 + items: *189 examples: - default: &191 + default: &195 value: - url: https://api.github.com/orgs/github type: Organization @@ -24041,15 +24622,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *186 + - *190 responses: '200': description: Response content: application/json: - schema: *185 + schema: *189 examples: - default: *187 + default: *191 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -24081,9 +24662,9 @@ paths: application/json: schema: type: array - items: *184 + items: *188 examples: - default: *188 + default: *192 headers: Link: *40 '401': *25 @@ -24106,8 +24687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *189 - - *190 + - *193 + - *194 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -24127,9 +24708,9 @@ paths: application/json: schema: type: array - items: *185 + items: *189 examples: - default: *191 + default: *195 headers: Link: *40 '401': *25 @@ -24393,14 +24974,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &407 + - &419 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &408 + - &420 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -24417,7 +24998,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -24471,7 +25052,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &421 + '301': &433 description: Moved permanently content: application/json: @@ -24493,7 +25074,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &635 + - &647 name: all description: If `true`, show notifications marked as read. in: query @@ -24501,7 +25082,7 @@ paths: schema: type: boolean default: false - - &636 + - &648 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -24510,8 +25091,8 @@ paths: schema: type: boolean default: false - - *170 - - &637 + - *174 + - &649 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -24536,18 +25117,18 @@ paths: application/json: schema: type: array - items: &193 + items: &197 title: Thread description: Thread type: object properties: id: type: string - repository: &224 + repository: &234 title: Minimal Repository description: Minimal Repository type: object - properties: &289 + properties: &299 id: type: integer format: int64 @@ -24823,7 +25404,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &355 + security_and_analysis: &365 nullable: true type: object properties: @@ -24905,7 +25486,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &290 + required: &300 - archive_url - assignees_url - blobs_url @@ -24993,7 +25574,7 @@ paths: - url - subscription_url examples: - default: &638 + default: &650 value: - id: '1' repository: @@ -25159,7 +25740,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &194 + - &198 name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications @@ -25173,7 +25754,7 @@ paths: description: Response content: application/json: - schema: *193 + schema: *197 examples: default: value: @@ -25276,7 +25857,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *194 + - *198 responses: '205': description: Reset Content @@ -25299,7 +25880,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *194 + - *198 responses: '204': description: No content @@ -25322,13 +25903,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *194 + - *198 responses: '200': description: Response content: application/json: - schema: &195 + schema: &199 title: Thread Subscription description: Thread Subscription type: object @@ -25365,7 +25946,7 @@ paths: - url - subscribed examples: - default: &196 + default: &200 value: subscribed: true ignored: false @@ -25396,7 +25977,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *194 + - *198 requestBody: required: false content: @@ -25417,9 +25998,9 @@ paths: description: Response content: application/json: - schema: *195 + schema: *199 examples: - default: *196 + default: *200 '304': *37 '403': *29 '401': *25 @@ -25442,7 +26023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *194 + - *198 responses: '204': description: Response @@ -25537,9 +26118,9 @@ paths: application/json: schema: type: array - items: *59 + items: *61 examples: - default: &771 + default: &783 value: - login: github id: 1 @@ -25603,7 +26184,7 @@ paths: type: integer custom_roles: type: array - items: &271 + items: &281 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -25651,7 +26232,7 @@ paths: - created_at - updated_at examples: - default: &272 + default: &282 value: id: 8030 name: Security Engineer @@ -25683,6 +26264,555 @@ 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: + - *75 + responses: + '200': + description: Response + content: + application/json: + schema: *201 + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': *29 + '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: + - *75 + requestBody: + required: true + content: + application/json: + schema: *202 + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': *29 + '404': *6 + '409': *101 + '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: + - *75 + responses: + '200': + description: Response + content: + application/json: + schema: *50 + examples: + default: *203 + '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: + - *75 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *50 + 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: + - *75 + responses: + '200': + description: Response + content: + application/json: + schema: *204 + examples: + default: *51 + '403': *29 + '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: + - *75 + requestBody: + required: true + content: + application/json: + schema: *205 + examples: + default: *51 + 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: + - *75 + 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': *29 + '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: + - *75 + 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': *29 + '404': *6 + '409': *101 + '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: + - *75 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: *66 + examples: + default: &229 + 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': *29 + '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: + - *75 + 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': *29 + '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: + - *75 + - &206 + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + responses: + '204': + description: No content + '403': *29 + '404': *6 + '409': *101 + '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: + - *75 + - *206 + responses: + '204': + description: No content + '403': *29 + '404': *6 + '409': *101 + '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 @@ -25698,7 +26828,7 @@ paths: 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 parameters: - - *73 + - *75 - name: page in: query description: The page number of results to fetch. @@ -25742,8 +26872,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *197 - required: *198 + properties: *207 + required: *208 nullable: true additionalProperties: false examples: @@ -25849,7 +26979,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -25915,7 +27045,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *73 + - *75 requestBody: required: true content: @@ -25962,23 +27092,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - *73 - - *199 - - *200 - - *201 - - *202 + - *75 + - *209 + - *210 + - *211 + - *212 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *203 + schema: *213 examples: - default: *204 + default: *214 '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26004,13 +27134,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: &205 + schema: &215 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -26343,7 +27473,7 @@ paths: - updated_at - archived_at examples: - default-response: &206 + default-response: &216 value: login: github id: 1 @@ -26445,7 +27575,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *73 + - *75 requestBody: required: false content: @@ -26668,18 +27798,18 @@ paths: description: Response content: application/json: - schema: *205 + schema: *215 examples: - default: *206 + default: *216 '422': description: Validation failed content: application/json: schema: oneOf: - - *207 - - *208 - '409': *99 + - *217 + - *218 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26702,7 +27832,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *73 + - *75 responses: '202': *39 '404': *6 @@ -26727,15 +27857,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *209 + schema: *219 examples: - default: *210 + default: *220 headers: Link: *40 x-github: @@ -26758,7 +27888,7 @@ paths: 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: - - *73 + - *75 - *17 - *19 responses: @@ -26776,7 +27906,7 @@ paths: type: integer repository_cache_usages: type: array - items: &426 + items: &438 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -26831,7 +27961,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *73 + - *75 - *17 - *19 responses: @@ -26851,7 +27981,7 @@ paths: type: array items: *42 examples: - default: *211 + default: *221 headers: Link: *40 x-github: @@ -26871,7 +28001,7 @@ paths: 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: - - *73 + - *75 requestBody: required: true content: @@ -26958,7 +28088,7 @@ paths: 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: - - *73 + - *75 responses: '200': description: Response @@ -26994,7 +28124,7 @@ paths: 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: - - *73 + - *75 responses: '200': description: Response @@ -27029,15 +28159,15 @@ paths: 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 parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *212 + schema: *222 examples: - default: *213 + default: *223 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27055,7 +28185,7 @@ paths: 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: - - *73 + - *75 responses: '200': description: Response @@ -27073,7 +28203,7 @@ paths: type: array items: *45 examples: - default: *214 + default: *224 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27091,7 +28221,7 @@ paths: 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 parameters: - - *73 + - *75 responses: '200': description: Response @@ -27135,7 +28265,7 @@ paths: 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: - - *73 + - *75 - *47 responses: '200': @@ -27164,7 +28294,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *73 + - *75 - *47 requestBody: required: true @@ -27221,7 +28351,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *73 + - *75 - *47 responses: '202': @@ -27250,13 +28380,13 @@ paths: 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: - - *73 + - *75 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &215 + schema: &225 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -27270,7 +28400,7 @@ paths: required: - include_claim_keys examples: - default: &216 + default: &226 value: include_claim_keys: - repo @@ -27292,20 +28422,20 @@ paths: 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 parameters: - - *73 + - *75 requestBody: required: true content: application/json: - schema: *215 + schema: *225 examples: - default: *216 + default: *226 responses: '201': description: Empty response content: application/json: - schema: &235 + schema: &245 title: Empty Object description: An object without any properties. type: object @@ -27335,7 +28465,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -27344,7 +28474,7 @@ paths: schema: type: object properties: - enabled_repositories: &218 + enabled_repositories: &228 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -27358,7 +28488,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *49 - selected_actions_url: *217 + selected_actions_url: *227 required: - enabled_repositories examples: @@ -27387,7 +28517,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *73 + - *75 responses: '204': description: Response @@ -27398,7 +28528,7 @@ paths: schema: type: object properties: - enabled_repositories: *218 + enabled_repositories: *228 allowed_actions: *49 required: - enabled_repositories @@ -27426,7 +28556,7 @@ paths: 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 parameters: - - *73 + - *75 - *17 - *19 responses: @@ -27444,129 +28574,9 @@ paths: type: number repositories: type: array - items: *64 + items: *66 examples: - default: &765 - 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 + default: *229 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -27586,7 +28596,7 @@ paths: 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 parameters: - - *73 + - *75 responses: '204': description: Response @@ -27630,14 +28640,8 @@ paths: 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 parameters: - - *73 - - &219 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer + - *75 + - *206 responses: '204': description: Response @@ -27659,8 +28663,8 @@ paths: 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 parameters: - - *73 - - *219 + - *75 + - *206 responses: '204': description: Response @@ -27683,15 +28687,15 @@ paths: 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: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *51 + schema: *53 examples: - default: *52 + default: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -27714,7 +28718,7 @@ paths: 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: - - *73 + - *75 responses: '204': description: Response @@ -27722,9 +28726,9 @@ paths: required: false content: application/json: - schema: *51 + schema: *53 examples: - selected_actions: *52 + selected_actions: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -27746,15 +28750,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *220 + schema: *230 examples: - default: *55 + default: *57 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27775,7 +28779,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *73 + - *75 responses: '204': description: Success response @@ -27786,9 +28790,9 @@ paths: required: false content: application/json: - schema: *221 + schema: *231 examples: - default: *55 + default: *57 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27808,7 +28812,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *73 + - *75 - *17 - *19 - name: visible_to_repository @@ -27833,7 +28837,7 @@ paths: type: number runner_groups: type: array - items: &222 + items: &232 type: object properties: id: @@ -27949,7 +28953,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -28021,9 +29025,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *232 examples: - default: &223 + default: &233 value: id: 2 name: octo-runner-group @@ -28058,14 +29062,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *73 - - *58 + - *75 + - *60 responses: '200': description: Response content: application/json: - schema: *222 + schema: *232 examples: default: value: @@ -28101,8 +29105,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *73 - - *58 + - *75 + - *60 requestBody: required: true content: @@ -28156,9 +29160,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *232 examples: - default: *223 + default: *233 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -28177,8 +29181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *73 - - *58 + - *75 + - *60 responses: '204': description: Response @@ -28201,8 +29205,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - - *73 - - *58 + - *75 + - *60 - *17 - *19 responses: @@ -28222,7 +29226,7 @@ paths: type: array items: *42 examples: - default: *211 + default: *221 headers: Link: *40 x-github: @@ -28244,8 +29248,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *73 - - *58 + - *75 + - *60 - *19 - *17 responses: @@ -28263,9 +29267,9 @@ paths: type: number repositories: type: array - items: *224 + items: *234 examples: - default: &756 + default: &769 value: total_count: 1 repositories: @@ -28517,8 +29521,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *73 - - *58 + - *75 + - *60 requestBody: required: true content: @@ -28562,9 +29566,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *73 - - *58 - - *219 + - *75 + - *60 + - *206 responses: '204': description: Response @@ -28586,9 +29590,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *73 - - *58 - - *219 + - *75 + - *60 + - *206 responses: '204': description: Response @@ -28611,8 +29615,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *73 - - *58 + - *75 + - *60 - *17 - *19 responses: @@ -28630,9 +29634,9 @@ paths: type: number runners: type: array - items: *62 + items: *64 examples: - default: *63 + default: *65 headers: Link: *40 x-github: @@ -28653,8 +29657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *73 - - *58 + - *75 + - *60 requestBody: required: true content: @@ -28698,9 +29702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *73 - - *58 - - *61 + - *75 + - *60 + - *63 responses: '204': description: Response @@ -28722,9 +29726,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *73 - - *58 - - *61 + - *75 + - *60 + - *63 responses: '204': description: Response @@ -28754,7 +29758,7 @@ paths: in: query schema: type: string - - *73 + - *75 - *17 - *19 responses: @@ -28772,9 +29776,9 @@ paths: type: integer runners: type: array - items: *62 + items: *64 examples: - default: *63 + default: *65 headers: Link: *40 x-github: @@ -28798,7 +29802,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -28806,9 +29810,9 @@ paths: application/json: schema: type: array - items: *225 + items: *235 examples: - default: *226 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28830,7 +29834,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -28873,10 +29877,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *227 + '201': *237 '404': *6 '422': *7 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28904,15 +29908,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *73 + - *75 responses: '201': description: Response content: application/json: - schema: *65 + schema: *67 examples: - default: *228 + default: *238 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28940,15 +29944,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *73 + - *75 responses: '201': description: Response content: application/json: - schema: *65 + schema: *67 examples: - default: *229 + default: *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28970,16 +29974,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 + - *75 + - *63 responses: '200': description: Response content: application/json: - schema: *62 + schema: *64 examples: - default: *230 + default: *240 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29000,8 +30004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *73 - - *61 + - *75 + - *63 responses: '204': description: Response @@ -29027,10 +30031,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 + - *75 + - *63 responses: - '200': *67 + '200': *69 '404': *6 x-github: githubCloudOnly: false @@ -29052,8 +30056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 + - *75 + - *63 requestBody: required: true content: @@ -29077,7 +30081,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -29101,8 +30105,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 + - *75 + - *63 requestBody: required: true content: @@ -29127,7 +30131,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -29151,10 +30155,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 + - *75 + - *63 responses: - '200': *231 + '200': *241 '404': *6 x-github: githubCloudOnly: false @@ -29181,11 +30185,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *73 - - *61 - - *232 + - *75 + - *63 + - *242 responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -29210,7 +30214,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *73 + - *75 - *17 - *19 responses: @@ -29228,7 +30232,7 @@ paths: type: integer secrets: type: array - items: &233 + items: &243 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -29301,13 +30305,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: &446 + schema: &458 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -29336,7 +30340,7 @@ paths: - key_id - key examples: - default: &447 + default: &459 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29361,8 +30365,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *73 - - &234 + - *75 + - &244 name: secret_name description: The name of the secret. in: path @@ -29374,7 +30378,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *243 examples: default: value: @@ -29404,8 +30408,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -29462,7 +30466,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -29488,8 +30492,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 responses: '204': description: Response @@ -29515,8 +30519,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - *19 - *17 responses: @@ -29534,9 +30538,9 @@ paths: type: integer repositories: type: array - items: *224 + items: *234 examples: - default: &238 + default: &248 value: total_count: 1 repositories: @@ -29628,8 +30632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -29681,8 +30685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -29715,8 +30719,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -29748,8 +30752,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *73 - - &431 + - *75 + - &443 name: per_page description: The number of results per page (max 30). 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)." @@ -29773,7 +30777,7 @@ paths: type: integer variables: type: array - items: &236 + items: &246 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -29858,7 +30862,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *73 + - *75 requestBody: required: true content: @@ -29906,7 +30910,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -29931,8 +30935,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *73 - - &237 + - *75 + - &247 name: name description: The name of the variable. in: path @@ -29944,7 +30948,7 @@ paths: description: Response content: application/json: - schema: *236 + schema: *246 examples: default: value: @@ -29974,8 +30978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 requestBody: required: true content: @@ -30037,8 +31041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 responses: '204': description: Response @@ -30064,8 +31068,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 - *19 - *17 responses: @@ -30083,9 +31087,9 @@ paths: type: integer repositories: type: array - items: *224 + items: *234 examples: - default: *238 + default: *248 '409': description: Response when the visibility of the variable is not set to `selected` @@ -30111,8 +31115,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 requestBody: required: true content: @@ -30161,8 +31165,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 - name: repository_id in: path required: true @@ -30196,8 +31200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *73 - - *237 + - *75 + - *247 - name: repository_id in: path required: true @@ -30228,15 +31232,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *72 + schema: *74 examples: - default: *71 + default: *73 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -30255,19 +31259,19 @@ paths: required: true content: application/json: - schema: *239 + schema: *249 examples: - default: *71 + default: *73 parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *72 + schema: *74 examples: - default: *71 + default: *73 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -30283,7 +31287,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *73 + - *75 responses: '204': description: Response @@ -30309,9 +31313,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations-by-bulk-subject-digests parameters: - *17 - - *89 - - *90 - - *73 + - *91 + - *92 + - *75 requestBody: required: true content: @@ -30334,12 +31338,12 @@ paths: required: - subject_digests examples: - default: &786 + default: &798 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &787 + withPredicateType: &799 value: subject_digests: - sha256:abc123 @@ -30397,7 +31401,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &788 + default: &800 value: attestations_subject_digests: - sha256:abc: @@ -30506,7 +31510,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *73 + - *75 requestBody: required: true content: @@ -30571,7 +31575,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *73 + - *75 - name: subject_digest description: Subject Digest in: path @@ -30602,7 +31606,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/attestations#delete-attestations-by-id parameters: - - *73 + - *75 - name: attestation_id description: Attestation ID in: path @@ -30638,9 +31642,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations parameters: - *17 - - *89 - - *90 - - *73 + - *91 + - *92 + - *75 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -30691,7 +31695,7 @@ paths: bundle_url: type: string examples: - default: &460 + default: &472 value: attestations: - bundle: @@ -30809,7 +31813,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - - *73 + - *75 - name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). @@ -30817,10 +31821,10 @@ paths: required: false schema: type: string - - *240 - - *241 - - *242 - - *243 + - *250 + - *251 + - *252 + - *253 - *17 responses: '200': @@ -30829,9 +31833,9 @@ paths: application/json: schema: type: array - items: *244 + items: *254 examples: - default: *245 + default: *255 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -30848,7 +31852,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *73 + - *75 - *17 - *19 responses: @@ -30860,7 +31864,7 @@ paths: type: array items: *4 examples: - default: &321 + default: &331 value: - login: octocat id: 1 @@ -30898,8 +31902,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: If the user is blocked @@ -30924,8 +31928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -30945,8 +31949,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -30972,17 +31976,17 @@ paths: category: orgs subcategory: bypass-requests parameters: - - *73 - - &253 + - *75 + - &263 name: repository_name description: The name of the repository to filter on. in: query schema: type: string - - *247 - - *248 - - *249 - - *250 + - *257 + - *258 + - *259 + - *260 - *17 - *19 responses: @@ -30992,11 +31996,11 @@ paths: application/json: schema: type: array - items: *251 + items: *261 examples: - default: *252 + default: *262 '404': *6 - '500': *88 + '500': *90 "/orgs/{org}/bypass-requests/secret-scanning": get: summary: List bypass requests for secret scanning for an org @@ -31017,12 +32021,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *73 - - *253 - - *247 - - *248 - - *249 - - *250 + - *75 + - *263 + - *257 + - *258 + - *259 + - *260 - *17 - *19 responses: @@ -31032,7 +32036,7 @@ paths: application/json: schema: type: array - items: &477 + items: &489 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -31146,7 +32150,7 @@ paths: type: array description: The responses to the bypass request. nullable: true - items: *254 + items: *264 url: type: string format: uri @@ -31157,7 +32161,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &478 + default: &490 value: - id: 21 number: 42 @@ -31224,7 +32228,7 @@ paths: url: https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/2 html_url: https://github.com/octo-org/smile/exemptions/2 '404': *6 - '500': *88 + '500': *90 "/orgs/{org}/campaigns": get: summary: List campaigns for an organization @@ -31241,15 +32245,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *73 + - *75 - *19 - *17 - - *91 + - *93 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &256 + schema: &266 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -31275,7 +32279,7 @@ paths: application/json: schema: type: array - items: &257 + items: &267 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -31306,7 +32310,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *255 + items: *265 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -31324,7 +32328,7 @@ paths: type: string format: date-time nullable: true - state: *256 + state: *266 contact_link: description: The contact link of the campaign. type: string @@ -31421,7 +32425,7 @@ paths: headers: Link: *40 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31445,7 +32449,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -31539,9 +32543,9 @@ paths: description: Response content: application/json: - schema: *257 + schema: *267 examples: - default: &258 + default: &268 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -31590,7 +32594,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31612,7 +32616,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *73 + - *75 - name: campaign_number description: The campaign number. in: path @@ -31624,16 +32628,16 @@ paths: description: Response content: application/json: - schema: *257 + schema: *267 examples: - default: *258 + default: *268 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31654,7 +32658,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign parameters: - - *73 + - *75 - name: campaign_number description: The campaign number. in: path @@ -31703,7 +32707,7 @@ paths: type: string format: uri nullable: true - state: *256 + state: *266 examples: default: value: @@ -31713,9 +32717,9 @@ paths: description: Response content: application/json: - schema: *257 + schema: *267 examples: - default: *258 + default: *268 '400': description: Bad Request content: @@ -31727,7 +32731,7 @@ paths: content: application/json: schema: *3 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31748,7 +32752,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *73 + - *75 - name: campaign_number description: The campaign number. in: path @@ -31759,7 +32763,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31781,20 +32785,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *73 - - *259 - - *260 - - *89 - - *90 + - *75 + - *269 + - *270 + - *91 + - *92 - *19 - *17 - - *91 + - *93 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: *261 + schema: *271 - name: sort description: The property by which to sort the results. in: query @@ -31810,7 +32814,7 @@ paths: be returned. in: query required: false - schema: &489 + schema: &501 type: string description: Severity of a code scanning alert. enum: @@ -31828,13 +32832,13 @@ paths: application/json: schema: type: array - items: *262 + items: *272 examples: - default: *263 + default: *273 headers: Link: *40 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31856,7 +32860,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *73 + - *75 - name: target_type in: query description: The target type of the code security configuration @@ -31875,8 +32879,8 @@ paths: schema: type: integer default: 30 - - *89 - - *90 + - *91 + - *92 responses: '200': description: Response @@ -31884,7 +32888,7 @@ paths: application/json: schema: type: array - items: *95 + items: *97 examples: default: value: @@ -31967,7 +32971,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *73 + - *75 requestBody: required: true content: @@ -32045,7 +33049,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *264 + code_scanning_options: *274 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -32054,7 +33058,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *98 + code_scanning_default_setup_options: *100 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -32186,9 +33190,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *95 + schema: *97 examples: - default: *265 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32210,15 +33214,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *266 + schema: *276 examples: - default: *267 + default: *277 '304': *37 '403': *29 '404': *6 @@ -32244,7 +33248,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *73 + - *75 requestBody: required: true content: @@ -32270,11 +33274,11 @@ paths: - 32 - 91 responses: - '204': *123 + '204': *125 '400': *14 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32296,16 +33300,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *73 - - *97 + - *75 + - *99 responses: '200': description: Response content: application/json: - schema: *95 + schema: *97 examples: - default: *265 + default: *275 '304': *37 '403': *29 '404': *6 @@ -32329,8 +33333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *73 - - *97 + - *75 + - *99 requestBody: required: true content: @@ -32409,7 +33413,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *98 + code_scanning_default_setup_options: *100 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -32527,7 +33531,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *95 + schema: *97 examples: default: value: @@ -32586,14 +33590,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *73 - - *97 + - *75 + - *99 responses: - '204': *123 + '204': *125 '400': *14 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32617,8 +33621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *73 - - *97 + - *75 + - *99 requestBody: required: true content: @@ -32681,8 +33685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *73 - - *97 + - *75 + - *99 requestBody: required: true content: @@ -32722,12 +33726,12 @@ paths: - none - private_and_internal - public - configuration: *95 + configuration: *97 examples: default: value: default_for_new_repos: all - configuration: *265 + configuration: *275 '403': *29 '404': *6 x-github: @@ -32751,8 +33755,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *73 - - *97 + - *75 + - *99 - 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)." @@ -32761,8 +33765,8 @@ paths: schema: type: integer default: 30 - - *89 - - *90 + - *91 + - *92 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -32780,13 +33784,13 @@ paths: application/json: schema: type: array - items: *268 + items: *278 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *269 + repository: *279 '403': *29 '404': *6 x-github: @@ -32810,7 +33814,7 @@ paths: parameters: - *17 - *19 - - *73 + - *75 responses: '200': description: Response @@ -32826,7 +33830,7 @@ paths: type: integer codespaces: type: array - items: &322 + items: &332 type: object title: Codespace description: A codespace. @@ -32851,12 +33855,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *224 + repository: *234 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &518 + properties: &530 name: type: string description: The name of the machine. @@ -32898,7 +33902,7 @@ paths: - ready - in_progress nullable: true - required: &519 + required: &531 - name - display_name - operating_system @@ -33103,7 +34107,7 @@ paths: - pulls_url - recent_folders examples: - default: &323 + default: &333 value: total_count: 3 codespaces: @@ -33513,7 +34517,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -33535,7 +34539,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *73 + - *75 deprecated: true requestBody: required: true @@ -33579,7 +34583,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33602,7 +34606,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *73 + - *75 deprecated: true requestBody: required: true @@ -33634,7 +34638,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33657,7 +34661,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *73 + - *75 requestBody: required: true content: @@ -33688,7 +34692,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33709,7 +34713,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *73 + - *75 - *17 - *19 responses: @@ -33727,7 +34731,7 @@ paths: type: integer secrets: type: array - items: &270 + items: &280 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -33766,7 +34770,7 @@ paths: - updated_at - visibility examples: - default: &520 + default: &532 value: total_count: 2 secrets: @@ -33798,13 +34802,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: &521 + schema: &533 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -33833,7 +34837,7 @@ paths: - key_id - key examples: - default: &522 + default: &534 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -33856,16 +34860,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 responses: '200': description: Response content: application/json: - schema: *270 + schema: *280 examples: - default: &524 + default: &536 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -33892,8 +34896,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -33948,7 +34952,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -33974,8 +34978,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 responses: '204': description: Response @@ -34000,8 +35004,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - *19 - *17 responses: @@ -34019,9 +35023,9 @@ paths: type: integer repositories: type: array - items: *224 + items: *234 examples: - default: *238 + default: *248 '404': *6 x-github: githubCloudOnly: false @@ -34043,8 +35047,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -34094,8 +35098,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -34128,8 +35132,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -34168,7 +35172,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *73 + - *75 responses: '200': description: OK @@ -34277,7 +35281,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34299,7 +35303,7 @@ paths: Only organization owners can view assigned seats. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -34309,7 +35313,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *73 + - *75 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -34332,12 +35336,12 @@ paths: currently being billed. seats: type: array - items: *114 + items: *116 examples: - default: *115 + default: *117 headers: Link: *40 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34370,7 +35374,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *73 + - *75 requestBody: content: application/json: @@ -34412,7 +35416,7 @@ paths: default: value: seats_created: 5 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34448,7 +35452,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *73 + - *75 requestBody: content: application/json: @@ -34490,7 +35494,7 @@ paths: default: value: seats_cancelled: 5 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34528,7 +35532,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *73 + - *75 requestBody: content: application/json: @@ -34569,7 +35573,7 @@ paths: default: value: seats_created: 5 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34605,7 +35609,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *73 + - *75 requestBody: content: application/json: @@ -34647,7 +35651,7 @@ paths: default: value: seats_cancelled: 5 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -34686,7 +35690,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *73 + - *75 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -34718,13 +35722,13 @@ paths: application/json: schema: type: array - items: *161 + items: *165 examples: - default: *162 - '500': *88 + default: *166 + '500': *90 '403': *29 '404': *6 - '422': *163 + '422': *167 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34746,7 +35750,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - - *73 + - *75 - *17 - name: page description: Page token @@ -34890,7 +35894,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - - *73 + - *75 - name: credential_id in: path required: true @@ -34921,7 +35925,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - - *73 + - *75 responses: '200': description: Response - list of custom role names @@ -34936,7 +35940,7 @@ paths: type: integer custom_roles: type: array - items: *271 + items: *281 examples: default: value: @@ -35023,12 +36027,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *73 + - *75 requestBody: required: true content: application/json: - schema: &274 + schema: &284 type: object properties: name: @@ -35069,9 +36073,9 @@ paths: description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '422': *15 '404': *6 x-github: @@ -35095,8 +36099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *73 - - &273 + - *75 + - &283 name: role_id description: The unique identifier of the role. in: path @@ -35108,9 +36112,9 @@ paths: description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '404': *6 x-github: githubCloudOnly: true @@ -35132,13 +36136,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *73 - - *273 + - *75 + - *283 requestBody: required: true content: application/json: - schema: &275 + schema: &285 type: object properties: name: @@ -35176,9 +36180,9 @@ paths: description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '422': *15 '404': *6 x-github: @@ -35202,8 +36206,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *73 - - *273 + - *75 + - *283 responses: '204': description: Response @@ -35231,12 +36235,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - - *73 + - *75 requestBody: required: true content: application/json: - schema: *274 + schema: *284 examples: default: value: @@ -35250,9 +36254,9 @@ paths: description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '422': *15 '404': *6 x-github: @@ -35282,16 +36286,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - - *73 - - *273 + - *75 + - *283 responses: '200': description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '404': *6 x-github: githubCloudOnly: true @@ -35319,13 +36323,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - - *73 - - *273 + - *75 + - *283 requestBody: required: true content: application/json: - schema: *275 + schema: *285 examples: default: value: @@ -35340,9 +36344,9 @@ paths: description: Response content: application/json: - schema: *271 + schema: *281 examples: - default: *272 + default: *282 '422': *15 '404': *6 x-github: @@ -35372,8 +36376,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - - *73 - - *273 + - *75 + - *283 responses: '204': description: Response @@ -35401,20 +36405,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *73 - - *276 - - *277 - - *278 - - *279 - - *280 - - *281 - - *282 - - *283 + - *75 + - *286 + - *287 + - *288 + - *289 + - *290 + - *291 + - *292 + - *293 + - *93 - *91 - - *89 - - *90 - - *284 - - *285 + - *92 + - *294 + - *295 - *17 responses: '200': @@ -35423,9 +36427,9 @@ paths: application/json: schema: type: array - items: *286 + items: *296 examples: - default: *287 + default: *297 '304': *37 '400': *14 '403': *29 @@ -35451,7 +36455,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *73 + - *75 - *17 - *19 responses: @@ -35469,7 +36473,7 @@ paths: type: integer secrets: type: array - items: &288 + items: &298 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -35540,13 +36544,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: &551 + schema: &563 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -35563,7 +36567,7 @@ paths: - key_id - key examples: - default: &552 + default: &564 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -35586,14 +36590,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 responses: '200': description: Response content: application/json: - schema: *288 + schema: *298 examples: default: value: @@ -35621,8 +36625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -35677,7 +36681,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -35701,8 +36705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 responses: '204': description: Response @@ -35726,8 +36730,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - *19 - *17 responses: @@ -35745,9 +36749,9 @@ paths: type: integer repositories: type: array - items: *224 + items: *234 examples: - default: *238 + default: *248 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35768,8 +36772,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -35819,8 +36823,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -35851,8 +36855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *73 - - *234 + - *75 + - *244 - name: repository_id in: path required: true @@ -35888,8 +36892,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *73 - - &560 + - *75 + - &572 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -35897,7 +36901,7 @@ paths: required: false schema: type: string - - &561 + - &573 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -35905,7 +36909,7 @@ paths: required: false schema: type: string - - &562 + - &574 name: time_period description: |- The time period to filter by. @@ -35921,7 +36925,7 @@ paths: - week - month default: month - - &563 + - &575 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -35936,7 +36940,7 @@ paths: - denied - all default: all - - *253 + - *263 - *17 - *19 responses: @@ -35946,7 +36950,7 @@ paths: application/json: schema: type: array - items: &564 + items: &576 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -36102,7 +37106,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &565 + default: &577 value: - id: 21 number: 42 @@ -36167,7 +37171,7 @@ paths: '404': *6 '403': *29 '422': *15 - '500': *88 + '500': *90 "/orgs/{org}/dismissal-requests/secret-scanning": get: summary: List alert dismissal requests for secret scanning for an org @@ -36188,12 +37192,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *73 - - *253 - - *247 - - *248 - - *249 - - &566 + - *75 + - *263 + - *257 + - *258 + - *259 + - &578 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -36219,7 +37223,7 @@ paths: application/json: schema: type: array - items: &567 + items: &579 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -36329,7 +37333,7 @@ paths: type: array description: The responses to the dismissal request. nullable: true - items: *254 + items: *264 url: type: string format: uri @@ -36340,7 +37344,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &568 + default: &580 value: - id: 21 number: 42 @@ -36405,7 +37409,7 @@ paths: html_url: https://github.com/octo-org/smile/security/secret-scanning/19 '404': *6 '403': *29 - '500': *88 + '500': *90 "/orgs/{org}/docker/conflicts": get: summary: Get list of conflicting packages during Docker migration for organization @@ -36420,7 +37424,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -36428,7 +37432,7 @@ paths: application/json: schema: type: array - items: &334 + items: &344 title: Package description: A software package type: object @@ -36478,8 +37482,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *289 - required: *290 + properties: *299 + required: *300 nullable: true created_at: type: string @@ -36498,7 +37502,7 @@ paths: - created_at - updated_at examples: - default: &335 + default: &345 value: - id: 197 name: hello_docker @@ -36576,7 +37580,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *73 + - *75 - *17 - *19 responses: @@ -36586,7 +37590,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: 200-response: value: @@ -36656,7 +37660,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *73 + - *75 - name: group_id description: The unique identifier of the group. in: path @@ -36682,7 +37686,7 @@ paths: description: Response content: application/json: - schema: &402 + schema: &414 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -36763,7 +37767,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &403 + default: &415 value: group_id: '123' group_name: Octocat admins @@ -36801,7 +37805,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-in-an-organization parameters: - - *73 + - *75 - *17 - name: page description: Page token @@ -36818,7 +37822,7 @@ paths: description: Response content: application/json: - schema: &400 + schema: &412 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -36855,7 +37859,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &401 + default: &413 value: groups: - group_id: '123' @@ -36889,7 +37893,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *73 + - *75 - *17 - *19 responses: @@ -36899,7 +37903,7 @@ paths: application/json: schema: type: array - items: &313 + items: &323 title: Organization Invitation description: Organization Invitation type: object @@ -36946,7 +37950,7 @@ paths: - invitation_teams_url - node_id examples: - default: &314 + default: &324 value: - id: 1 login: monalisa @@ -37005,7 +38009,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -37013,7 +38017,7 @@ paths: application/json: schema: type: array - items: &356 + items: &366 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -37027,7 +38031,7 @@ paths: - name - description examples: - default: &357 + default: &367 value: - name: add_assignee description: Assign or remove a user @@ -37058,7 +38062,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *73 + - *75 - *17 - *19 responses: @@ -37068,7 +38072,7 @@ paths: application/json: schema: type: array - items: &291 + items: &301 title: Org Hook description: Org Hook type: object @@ -37177,7 +38181,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *73 + - *75 requestBody: required: true content: @@ -37237,9 +38241,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *301 examples: - default: &292 + default: &302 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -37283,8 +38287,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *73 - - &293 + - *75 + - &303 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. @@ -37297,9 +38301,9 @@ paths: description: Response content: application/json: - schema: *291 + schema: *301 examples: - default: *292 + default: *302 '404': *6 x-github: githubCloudOnly: false @@ -37320,8 +38324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 requestBody: required: false content: @@ -37366,7 +38370,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *301 examples: default: value: @@ -37405,8 +38409,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 responses: '204': description: Response @@ -37431,8 +38435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *73 - - *293 + - *75 + - *303 responses: '200': description: Response @@ -37460,8 +38464,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *73 - - *293 + - *75 + - *303 requestBody: required: false content: @@ -37509,10 +38513,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 - *17 - - *294 + - *304 responses: '200': description: Response @@ -37520,9 +38524,9 @@ paths: application/json: schema: type: array - items: *295 + items: *305 examples: - default: *296 + default: *306 '400': *14 '422': *15 x-github: @@ -37545,17 +38549,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 - *16 responses: '200': description: Response content: application/json: - schema: *297 + schema: *307 examples: - default: *298 + default: *308 '400': *14 '422': *15 x-github: @@ -37578,8 +38582,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 - *16 responses: '202': *39 @@ -37605,8 +38609,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *73 - - *293 + - *75 + - *303 responses: '204': description: Response @@ -37628,8 +38632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *73 - - &303 + - *75 + - &313 name: actor_type in: path description: The type of the actor @@ -37642,14 +38646,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &304 + - &314 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &299 + - &309 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -37657,7 +38661,7 @@ paths: required: true schema: type: string - - &300 + - &310 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -37668,7 +38672,7 @@ paths: type: string - *19 - *17 - - *91 + - *93 - name: sort description: The property to sort the results by. in: query @@ -37750,13 +38754,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *73 - - *299 - - *300 + - *75 + - *309 + - *310 - *19 - *17 - - *91 - - &309 + - *93 + - &319 name: sort description: The property to sort the results by. in: query @@ -37834,15 +38838,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *73 - - *299 - - *300 + - *75 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: &301 + schema: &311 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -37858,7 +38862,7 @@ paths: type: integer format: int64 examples: - default: &302 + default: &312 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -37878,24 +38882,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *73 - - &305 + - *75 + - &315 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *299 - - *300 + - *309 + - *310 responses: '200': description: Response content: application/json: - schema: *301 + schema: *311 examples: - default: *302 + default: *312 x-github: enabledForGitHubApps: true category: orgs @@ -37913,19 +38917,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *73 - - *299 - - *300 - - *303 - - *304 + - *75 + - *309 + - *310 + - *313 + - *314 responses: '200': description: Response content: application/json: - schema: *301 + schema: *311 examples: - default: *302 + default: *312 x-github: enabledForGitHubApps: true category: orgs @@ -37942,10 +38946,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *73 - - *299 - - *300 - - &306 + - *75 + - *309 + - *310 + - &316 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -37958,7 +38962,7 @@ paths: description: Response content: application/json: - schema: &307 + schema: &317 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -37974,7 +38978,7 @@ paths: type: integer format: int64 examples: - default: &308 + default: &318 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -38010,19 +39014,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *73 - - *305 - - *299 - - *300 - - *306 + - *75 + - *315 + - *309 + - *310 + - *316 responses: '200': description: Response content: application/json: - schema: *307 + schema: *317 examples: - default: *308 + default: *318 x-github: enabledForGitHubApps: true category: orgs @@ -38039,20 +39043,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *73 - - *303 - - *304 - - *299 - - *300 - - *306 + - *75 + - *313 + - *314 + - *309 + - *310 + - *316 responses: '200': description: Response content: application/json: - schema: *307 + schema: *317 examples: - default: *308 + default: *318 x-github: enabledForGitHubApps: true category: orgs @@ -38069,14 +39073,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *73 - - *305 - - *299 - - *300 + - *75 + - *315 + - *309 + - *310 - *19 - *17 - - *91 - - *309 + - *93 + - *319 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -38149,7 +39153,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *73 + - *75 responses: '200': description: Response @@ -38157,7 +39161,7 @@ paths: application/json: schema: *22 examples: - default: &599 + default: &611 value: id: 1 account: @@ -38226,7 +39230,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *73 + - *75 - *17 - *19 responses: @@ -38315,7 +39319,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -38323,12 +39327,12 @@ paths: application/json: schema: anyOf: - - &311 + - &321 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &310 + limit: &320 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -38353,7 +39357,7 @@ paths: properties: {} additionalProperties: false examples: - default: &312 + default: &322 value: limit: collaborators_only origin: organization @@ -38377,18 +39381,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: application/json: - schema: &600 + schema: &612 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *310 + limit: *320 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -38412,9 +39416,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *321 examples: - default: *312 + default: *322 '422': *15 x-github: githubCloudOnly: false @@ -38432,7 +39436,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *73 + - *75 responses: '204': description: Response @@ -38458,7 +39462,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *73 + - *75 - *17 - *19 - name: role @@ -38492,9 +39496,9 @@ paths: application/json: schema: type: array - items: *313 + items: *323 examples: - default: *314 + default: *324 headers: Link: *40 '404': *6 @@ -38518,7 +39522,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *73 + - *75 requestBody: required: false content: @@ -38572,7 +39576,7 @@ paths: description: Response content: application/json: - schema: *313 + schema: *323 examples: default: value: @@ -38628,8 +39632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *73 - - &315 + - *75 + - &325 name: invitation_id description: The unique identifier of the invitation. in: path @@ -38662,8 +39666,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *73 - - *315 + - *75 + - *325 - *17 - *19 responses: @@ -38673,9 +39677,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: &333 + default: &343 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -38710,7 +39714,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -38718,7 +39722,7 @@ paths: application/json: schema: type: array - items: *316 + items: *326 examples: default: value: @@ -38756,7 +39760,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -38803,9 +39807,9 @@ paths: description: Response content: application/json: - schema: *316 + schema: *326 examples: - default: &317 + default: &327 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -38837,8 +39841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *73 - - &318 + - *75 + - &328 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -38891,9 +39895,9 @@ paths: description: Response content: application/json: - schema: *316 + schema: *326 examples: - default: *317 + default: *327 '404': *6 '422': *7 x-github: @@ -38917,8 +39921,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *73 - - *318 + - *75 + - *328 responses: '204': description: Response @@ -38951,7 +39955,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *73 + - *75 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -38981,7 +39985,7 @@ paths: - closed - all default: open - - *319 + - *329 - name: type description: Can be the name of an issue type. in: query @@ -38999,8 +40003,8 @@ paths: - updated - comments default: created - - *91 - - *170 + - *93 + - *174 - *17 - *19 responses: @@ -39010,9 +40014,9 @@ paths: application/json: schema: type: array - items: *180 + items: *184 examples: - default: *320 + default: *330 headers: Link: *40 '404': *6 @@ -39034,7 +40038,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *73 + - *75 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -39072,7 +40076,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '422': *15 @@ -39092,8 +40096,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response if requester is an organization member and user is @@ -39127,8 +40131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -39154,8 +40158,8 @@ paths: parameters: - *17 - *19 - - *73 - - *246 + - *75 + - *256 responses: '200': description: Response @@ -39171,11 +40175,11 @@ paths: type: integer codespaces: type: array - items: *322 + items: *332 examples: - default: *323 + default: *333 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -39198,9 +40202,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *73 - - *246 - - &324 + - *75 + - *256 + - &334 name: codespace_name in: path required: true @@ -39210,7 +40214,7 @@ paths: responses: '202': *39 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -39233,17 +40237,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *73 - - *246 - - *324 + - *75 + - *256 + - *334 responses: '200': description: Response content: application/json: - schema: *322 + schema: *332 examples: - default: &517 + default: &529 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -39385,7 +40389,7 @@ paths: recent_folders: [] template: '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -39404,7 +40408,7 @@ paths: Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -39416,14 +40420,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *114 + schema: *116 examples: default: value: @@ -39466,7 +40470,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -39491,14 +40495,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '200': description: Response content: application/json: - schema: &325 + schema: &335 title: Org Membership description: Org Membership type: object @@ -39542,7 +40546,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *59 + organization: *61 user: title: Simple User description: A GitHub user. @@ -39565,7 +40569,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &326 + response-if-user-has-an-active-admin-membership-with-organization: &336 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -39633,8 +40637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 requestBody: required: false content: @@ -39662,9 +40666,9 @@ paths: description: Response content: application/json: - schema: *325 + schema: *335 examples: - response-if-user-already-had-membership-with-organization: *326 + response-if-user-already-had-membership-with-organization: *336 '422': *15 '403': *29 x-github: @@ -39688,8 +40692,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -39714,7 +40718,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *73 + - *75 - *17 - *19 - name: exclude @@ -39735,7 +40739,7 @@ paths: application/json: schema: type: array - items: &327 + items: &337 title: Migration description: A migration. type: object @@ -39776,7 +40780,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *64 + items: *66 url: type: string format: uri @@ -39988,7 +40992,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *73 + - *75 requestBody: required: true content: @@ -40064,7 +41068,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *337 examples: default: value: @@ -40242,8 +41246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *73 - - &328 + - *75 + - &338 name: migration_id description: The unique identifier of the migration. in: path @@ -40270,7 +41274,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *327 + schema: *337 examples: default: value: @@ -40439,8 +41443,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *73 - - *328 + - *75 + - *338 responses: '302': description: Response @@ -40461,8 +41465,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *73 - - *328 + - *75 + - *338 responses: '204': description: Response @@ -40485,9 +41489,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *73 - - *328 - - &770 + - *75 + - *338 + - &782 name: repo_name description: repo_name parameter in: path @@ -40514,8 +41518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *73 - - *328 + - *75 + - *338 - *17 - *19 responses: @@ -40525,9 +41529,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: &340 + default: &350 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -40666,7 +41670,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -40720,7 +41724,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response - list of organization roles @@ -40736,7 +41740,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &329 + items: &339 title: Organization Role description: Organization roles type: object @@ -40896,7 +41900,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *73 + - *75 requestBody: required: true content: @@ -40943,7 +41947,7 @@ paths: description: Response content: application/json: - schema: *329 + schema: *339 examples: default: value: @@ -40972,7 +41976,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -40994,8 +41998,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *73 - - &330 + - *75 + - &340 name: team_slug description: The slug of the team name. in: path @@ -41026,9 +42030,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *73 - - *330 - - *273 + - *75 + - *340 + - *283 responses: '204': description: Response @@ -41057,9 +42061,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *73 - - *330 - - *273 + - *75 + - *340 + - *283 responses: '204': description: Response @@ -41084,8 +42088,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -41110,9 +42114,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *73 - - *246 - - *273 + - *75 + - *256 + - *283 responses: '204': description: Response @@ -41142,9 +42146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *73 - - *246 - - *273 + - *75 + - *256 + - *283 responses: '204': description: Response @@ -41172,14 +42176,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *73 - - *273 + - *75 + - *283 responses: '200': description: Response content: application/json: - schema: *329 + schema: *339 examples: default: value: @@ -41236,8 +42240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *73 - - *273 + - *75 + - *283 requestBody: required: true content: @@ -41276,7 +42280,7 @@ paths: description: Response content: application/json: - schema: *329 + schema: *339 examples: default: value: @@ -41304,7 +42308,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *99 + '409': *101 '404': *6 x-github: githubCloudOnly: true @@ -41329,8 +42333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *73 - - *273 + - *75 + - *283 responses: '204': description: Response @@ -41355,8 +42359,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *73 - - *273 + - *75 + - *283 - *17 - *19 responses: @@ -41434,8 +42438,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *331 - required: *332 + properties: *341 + required: *342 nullable: true required: - id @@ -41450,7 +42454,7 @@ paths: - slug - parent examples: - default: *333 + default: *343 headers: Link: *40 '404': @@ -41479,8 +42483,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *73 - - *273 + - *75 + - *283 - *17 - *19 responses: @@ -41508,13 +42512,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &374 + items: &386 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *331 - required: *332 + properties: *341 + required: *342 name: nullable: true type: string @@ -41609,7 +42613,7 @@ paths: - type - url examples: - default: *321 + default: *331 headers: Link: *40 '404': @@ -41633,7 +42637,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *73 + - *75 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -41660,7 +42664,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -41685,8 +42689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *73 - - *246 + - *75 + - *256 requestBody: required: false content: @@ -41743,8 +42747,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -41801,8 +42805,8 @@ paths: - docker - nuget - container - - *73 - - &772 + - *75 + - &784 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -41838,12 +42842,12 @@ paths: application/json: schema: type: array - items: *334 + items: *344 examples: - default: *335 + default: *345 '403': *29 '401': *25 - '400': &774 + '400': &786 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -41865,7 +42869,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &336 + - &346 name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry @@ -41883,20 +42887,20 @@ paths: - docker - nuget - container - - &337 + - &347 name: package_name description: The name of the package. in: path required: true schema: type: string - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *334 + schema: *344 examples: default: value: @@ -41948,9 +42952,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *336 - - *337 - - *73 + - *346 + - *347 + - *75 responses: '204': description: Response @@ -41982,9 +42986,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *336 - - *337 - - *73 + - *346 + - *347 + - *75 - name: token description: package token schema: @@ -42016,9 +43020,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *336 - - *337 - - *73 + - *346 + - *347 + - *75 - *19 - *17 - name: state @@ -42038,7 +43042,7 @@ paths: application/json: schema: type: array - items: &338 + items: &348 title: Package Version description: A version of a software package type: object @@ -42163,10 +43167,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *336 - - *337 - - *73 - - &339 + - *346 + - *347 + - *75 + - &349 name: package_version_id description: Unique identifier of the package version. in: path @@ -42178,7 +43182,7 @@ paths: description: Response content: application/json: - schema: *338 + schema: *348 examples: default: value: @@ -42214,10 +43218,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *336 - - *337 - - *73 - - *339 + - *346 + - *347 + - *75 + - *349 responses: '204': description: Response @@ -42249,10 +43253,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *336 - - *337 - - *73 - - *339 + - *346 + - *347 + - *75 + - *349 responses: '204': description: Response @@ -42279,10 +43283,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *73 + - *75 - *17 - *19 - - &341 + - &351 name: sort description: The property by which to sort the results. in: query @@ -42292,8 +43296,8 @@ paths: enum: - created_at default: created_at - - *91 - - &342 + - *93 + - &352 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -42304,7 +43308,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &343 + - &353 name: repository description: The name of the repository to use to filter the results. in: query @@ -42312,7 +43316,7 @@ paths: schema: type: string example: Hello-World - - &344 + - &354 name: permission description: The permission to use to filter the results. in: query @@ -42320,7 +43324,7 @@ paths: schema: type: string example: issues_read - - &345 + - &355 name: last_used_before description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -42330,7 +43334,7 @@ paths: schema: type: string format: date-time - - &346 + - &356 name: last_used_after description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -42340,7 +43344,7 @@ paths: schema: type: string format: date-time - - &347 + - &357 name: token_id description: The ID of the token in: query @@ -42352,7 +43356,7 @@ paths: type: string example: token_id[]=1,token_id[]=2 responses: - '500': *88 + '500': *90 '422': *15 '404': *6 '403': *29 @@ -42504,7 +43508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *73 + - *75 requestBody: required: true content: @@ -42545,7 +43549,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *88 + '500': *90 '422': *15 '404': *6 '403': *29 @@ -42570,7 +43574,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *73 + - *75 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -42606,11 +43610,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *88 + '500': *90 '422': *15 '404': *6 '403': *29 - '204': *123 + '204': *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42631,7 +43635,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *73 + - *75 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -42642,7 +43646,7 @@ paths: - *17 - *19 responses: - '500': *88 + '500': *90 '404': *6 '403': *29 '200': @@ -42651,9 +43655,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -42676,19 +43680,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *73 + - *75 - *17 - *19 - - *341 - - *91 - - *342 - - *343 - - *344 - - *345 - - *346 - - *347 - responses: - '500': *88 + - *351 + - *93 + - *352 + - *353 + - *354 + - *355 + - *356 + - *357 + responses: + '500': *90 '422': *15 '404': *6 '403': *29 @@ -42835,7 +43839,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *73 + - *75 requestBody: required: true content: @@ -42870,7 +43874,7 @@ paths: - 1296269 - 1296280 responses: - '500': *88 + '500': *90 '404': *6 '202': *39 '403': *29 @@ -42895,7 +43899,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *73 + - *75 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -42923,9 +43927,9 @@ paths: value: action: revoke responses: - '500': *88 + '500': *90 '404': *6 - '204': *123 + '204': *125 '403': *29 '422': *15 x-github: @@ -42947,7 +43951,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *73 + - *75 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -42957,7 +43961,7 @@ paths: - *17 - *19 responses: - '500': *88 + '500': *90 '404': *6 '403': *29 '200': @@ -42966,9 +43970,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -42992,7 +43996,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *73 + - *75 - *17 - *19 responses: @@ -43010,7 +44014,7 @@ paths: type: integer configurations: type: array - items: &348 + items: &358 title: Organization private registry description: Private registry configuration for an organization type: object @@ -43098,7 +44102,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -43263,7 +44267,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &349 + org-private-registry-with-selected-visibility: &359 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -43304,7 +44308,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -43352,16 +44356,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *73 - - *234 + - *75 + - *244 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *348 + schema: *358 examples: - default: *349 + default: *359 '404': *6 x-github: githubCloudOnly: false @@ -43382,8 +44386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *73 - - *234 + - *75 + - *244 requestBody: required: true content: @@ -43478,8 +44482,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *73 - - *234 + - *75 + - *244 responses: '204': description: Response @@ -43504,7 +44508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-organization-projects parameters: - - *73 + - *75 - name: state description: Indicates the state of the projects to return. in: query @@ -43525,7 +44529,7 @@ paths: application/json: schema: type: array - items: &350 + items: &360 title: Project description: Projects are a way to organize columns and cards of work. @@ -43672,7 +44676,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-an-organization-project parameters: - - *73 + - *75 requestBody: required: true content: @@ -43698,7 +44702,7 @@ paths: description: Response content: application/json: - schema: *350 + schema: *360 examples: default: value: @@ -43736,7 +44740,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': &418 + '410': &430 description: Gone content: application/json: @@ -43763,7 +44767,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -43771,9 +44775,9 @@ paths: application/json: schema: type: array - items: *119 + items: *121 examples: - default: *120 + default: *122 '403': *29 '404': *6 x-github: @@ -43800,7 +44804,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -43811,7 +44815,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *119 + items: *121 minItems: 1 maxItems: 100 required: @@ -43841,9 +44845,9 @@ paths: application/json: schema: type: array - items: *119 + items: *121 examples: - default: *120 + default: *122 '403': *29 '404': *6 x-github: @@ -43864,16 +44868,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *73 - - *121 + - *75 + - *123 responses: '200': description: Response content: application/json: - schema: *119 + schema: *121 examples: - default: *122 + default: *124 '403': *29 '404': *6 x-github: @@ -43896,13 +44900,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *73 - - *121 + - *75 + - *123 requestBody: required: true content: application/json: - schema: *351 + schema: *361 examples: default: value: @@ -43918,9 +44922,9 @@ paths: description: Response content: application/json: - schema: *119 + schema: *121 examples: - default: *122 + default: *124 '403': *29 '404': *6 x-github: @@ -43943,10 +44947,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *73 - - *121 + - *75 + - *123 responses: - '204': *123 + '204': *125 '403': *29 '404': *6 x-github: @@ -43967,7 +44971,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *73 + - *75 - *17 - *19 - name: repository_query @@ -44005,7 +45009,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &352 + items: &362 title: Custom Property Value description: Custom property name and associated value type: object @@ -44072,7 +45076,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *73 + - *75 requestBody: required: true content: @@ -44092,7 +45096,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *352 + items: *362 required: - repository_names - properties @@ -44133,7 +45137,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *73 + - *75 - *17 - *19 responses: @@ -44145,7 +45149,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -44164,8 +45168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response if user is a public member @@ -44189,8 +45193,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -44211,8 +45215,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *73 - - *246 + - *75 + - *256 responses: '204': description: Response @@ -44236,7 +45240,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *73 + - *75 - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation @@ -44283,9 +45287,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -44306,7 +45310,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *73 + - *75 requestBody: required: true content: @@ -44488,7 +45492,7 @@ paths: description: Response content: application/json: - schema: &420 + schema: &432 title: Full Repository description: Full Repository type: object @@ -44765,8 +45769,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *353 - required: *354 + properties: *363 + required: *364 nullable: true temp_clone_token: type: string @@ -44853,8 +45857,8 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true organization: title: Simple User @@ -44863,8 +45867,8 @@ paths: properties: *20 required: *21 nullable: true - parent: *64 - source: *64 + parent: *66 + source: *66 forks: type: integer master_branch: @@ -44881,7 +45885,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &539 + properties: &551 url: type: string format: uri @@ -44897,12 +45901,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &540 + required: &552 - url - key - name - html_url - security_and_analysis: *355 + security_and_analysis: *365 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -44986,7 +45990,7 @@ paths: - network_count - subscribers_count examples: - default: &422 + default: &434 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -45504,7 +46508,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response @@ -45512,9 +46516,9 @@ paths: application/json: schema: type: array - items: *356 + items: *366 examples: - default: *357 + default: *367 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -45536,10 +46540,10 @@ paths: category: orgs subcategory: rules parameters: - - *73 + - *75 - *17 - *19 - - &668 + - &680 name: targets description: | A comma-separated list of rule targets to filter by. @@ -45557,7 +46561,7 @@ paths: application/json: schema: type: array - items: *152 + items: *154 examples: default: value: @@ -45588,7 +46592,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -45604,7 +46608,7 @@ paths: category: orgs subcategory: rules parameters: - - *73 + - *75 requestBody: description: Request body required: true @@ -45625,22 +46629,20 @@ paths: - push - repository default: branch - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 - conditions: *358 + items: *133 + conditions: *368 rules: type: array description: An array of rules within the ruleset. - items: &360 + items: &370 title: Repository Rule type: object description: A repository rule. oneOf: - - *132 - - *133 - *134 - *135 - *136 @@ -45659,6 +46661,8 @@ paths: - *149 - *150 - *151 + - *152 + - *153 required: - name - enforcement @@ -45696,9 +46700,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: &359 + default: &369 value: id: 21 name: super cool ruleset @@ -45738,7 +46742,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -45752,8 +46756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *73 - - &670 + - *75 + - &682 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -45763,16 +46767,16 @@ paths: schema: type: string x-multi-segment: true - - *253 - - *249 - - &671 + - *263 + - *259 + - &683 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &672 + - &684 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -45792,7 +46796,7 @@ paths: description: Response content: application/json: - schema: &673 + schema: &685 title: Rule Suites description: Response type: array @@ -45847,7 +46851,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &674 + default: &686 value: - id: 21 actor_id: 12 @@ -45871,7 +46875,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45890,8 +46894,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *73 - - &675 + - *75 + - &687 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -45907,7 +46911,7 @@ paths: description: Response content: application/json: - schema: &676 + schema: &688 title: Rule Suite description: Response type: object @@ -46006,7 +47010,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &677 + default: &689 value: id: 21 actor_id: 12 @@ -46041,7 +47045,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46067,7 +47071,7 @@ paths: category: orgs subcategory: rules parameters: - - *73 + - *75 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46079,11 +47083,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *359 + default: *369 '404': *6 - '500': *88 + '500': *90 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -46099,7 +47103,7 @@ paths: category: orgs subcategory: rules parameters: - - *73 + - *75 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46125,16 +47129,16 @@ paths: - tag - push - repository - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 - conditions: *358 + items: *133 + conditions: *368 rules: description: An array of rules within the ruleset. type: array - items: *360 + items: *370 examples: default: value: @@ -46169,11 +47173,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *359 + default: *369 '404': *6 - '500': *88 + '500': *90 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -46189,7 +47193,7 @@ paths: category: orgs subcategory: rules parameters: - - *73 + - *75 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46200,7 +47204,7 @@ paths: '204': description: Response '404': *6 - '500': *88 + '500': *90 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -46212,7 +47216,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-history parameters: - - *73 + - *75 - *17 - *19 - name: ruleset_id @@ -46228,11 +47232,11 @@ paths: application/json: schema: type: array - items: *156 + items: *158 examples: - default: *361 + default: *371 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46249,7 +47253,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules#get-organization-ruleset-version parameters: - - *73 + - *75 - name: ruleset_id description: The ID of the ruleset. in: path @@ -46267,7 +47271,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *372 examples: default: value: @@ -46307,7 +47311,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46329,15 +47333,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *73 - - *363 - - *364 - - *365 - - *366 - - *91 + - *75 + - *373 + - *374 + - *375 + - *376 + - *93 - *19 - *17 - - &679 + - &691 name: before description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -46347,7 +47351,7 @@ paths: required: false schema: type: string - - &680 + - &692 name: after description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -46357,10 +47361,10 @@ paths: required: false schema: type: string - - *367 - - *368 - - *369 - - *370 + - *377 + - *378 + - *379 + - *380 responses: '200': description: Response @@ -46368,18 +47372,138 @@ paths: application/json: schema: type: array - items: *371 + items: *381 examples: - default: *372 + default: *382 headers: Link: *40 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/pattern-configurations": + get: + summary: List organization pattern configurations + description: |- + Lists the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *75 + responses: + '200': + description: Response + content: + application/json: + schema: *383 + examples: + default: *384 + '403': *29 + '404': *6 + patch: + summary: Update organization pattern configurations + description: |- + Updates the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - *75 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: *161 + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: *161 + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': *14 + '403': *29 + '404': *6 + '409': *101 + '422': *15 "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization @@ -46396,8 +47520,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *73 - - *91 + - *75 + - *93 - name: sort description: The property to sort the results by. in: query @@ -46409,8 +47533,8 @@ paths: - updated - published default: created - - *89 - - *90 + - *91 + - *92 - name: per_page description: The number of advisories to return per page. 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)." @@ -46440,7 +47564,7 @@ paths: application/json: schema: type: array - items: &701 + items: &713 description: A repository security advisory. type: object properties: @@ -46627,7 +47751,7 @@ paths: required: - vector_string - score - cvss_severities: *105 + cvss_severities: *107 cwes: type: array nullable: true @@ -46660,7 +47784,7 @@ paths: login: type: string description: The username of the user credited. - type: *373 + type: *385 credits_detailed: type: array nullable: true @@ -46670,7 +47794,7 @@ paths: type: object properties: user: *4 - type: *373 + type: *385 state: type: string description: The state of the user's acceptance of the @@ -46694,14 +47818,14 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *255 + items: *265 private_fork: readOnly: true nullable: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *100 + - *102 required: - ghsa_id - cve_id @@ -46731,7 +47855,7 @@ paths: - private_fork additionalProperties: false examples: - default: &702 + default: &714 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -47110,7 +48234,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *73 + - *75 responses: '200': description: Response @@ -47118,9 +48242,9 @@ paths: application/json: schema: type: array - items: *374 + items: *386 examples: - default: *333 + default: *343 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47143,8 +48267,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '204': description: Response @@ -47169,8 +48293,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '204': description: Response @@ -47199,15 +48323,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *375 + schema: *387 examples: - default: *376 + default: *388 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47231,8 +48355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - - *73 - - *377 + - *75 + - *389 - *17 - *19 responses: @@ -47240,9 +48364,9 @@ paths: description: Success content: application/json: - schema: *378 + schema: *390 examples: - default: *379 + default: *391 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -47264,15 +48388,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *380 + schema: *392 examples: - default: *381 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47294,15 +48418,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *382 + schema: *394 examples: - default: *383 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47322,7 +48446,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *73 + - *75 - *17 - *19 responses: @@ -47340,9 +48464,9 @@ paths: type: integer network_configurations: type: array - items: *116 + items: *118 examples: - default: *384 + default: *396 headers: Link: *40 x-github: @@ -47363,7 +48487,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization parameters: - - *73 + - *75 requestBody: required: true content: @@ -47405,9 +48529,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: *117 + default: *119 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47427,16 +48551,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization parameters: - - *73 - - *118 + - *75 + - *120 responses: '200': description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: *117 + default: *119 headers: Link: *40 x-github: @@ -47457,8 +48581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - - *73 - - *118 + - *75 + - *120 requestBody: required: true content: @@ -47497,9 +48621,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *118 examples: - default: *117 + default: *119 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47518,8 +48642,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization parameters: - - *73 - - *118 + - *75 + - *120 responses: '204': description: Response @@ -47542,16 +48666,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization parameters: - - *73 - - *385 + - *75 + - *397 responses: '200': description: Response content: application/json: - schema: *386 + schema: *398 examples: - default: *387 + default: *399 headers: Link: *40 x-github: @@ -47570,7 +48694,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - - *73 + - *75 - *17 - name: page description: Page token @@ -47589,7 +48713,7 @@ paths: description: Response content: application/json: - schema: &409 + schema: &421 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -47635,7 +48759,7 @@ paths: type: string nullable: true examples: - default: &410 + default: &422 value: groups: - group_id: '123' @@ -47680,8 +48804,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *73 - - *330 + - *75 + - *340 - name: since description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). @@ -47713,13 +48837,13 @@ paths: application/json: schema: type: array - items: *161 + items: *165 examples: - default: *162 - '500': *88 + default: *166 + '500': *90 '403': *29 '404': *6 - '422': *163 + '422': *167 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47737,7 +48861,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *73 + - *75 - *17 - *19 responses: @@ -47747,9 +48871,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 headers: Link: *40 '403': *29 @@ -47771,7 +48895,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *73 + - *75 requestBody: required: true content: @@ -47843,7 +48967,7 @@ paths: description: Response content: application/json: - schema: &388 + schema: &400 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -47906,8 +49030,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *331 - required: *332 + properties: *341 + required: *342 nullable: true members_count: type: integer @@ -48153,7 +49277,7 @@ paths: - repos_count - organization examples: - default: &389 + default: &401 value: id: 1 node_id: MDQ6VGVhbTE= @@ -48223,16 +49347,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *73 - - *330 + - *75 + - *340 responses: '200': description: Response content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '404': *6 x-github: githubCloudOnly: false @@ -48253,8 +49377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *73 - - *330 + - *75 + - *340 requestBody: required: false content: @@ -48316,16 +49440,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '201': description: Response content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '404': *6 '422': *15 '403': *29 @@ -48350,8 +49474,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '204': description: Response @@ -48377,9 +49501,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *73 - - *330 - - *91 + - *75 + - *340 + - *93 - *17 - *19 - name: pinned @@ -48395,7 +49519,7 @@ paths: application/json: schema: type: array - items: &390 + items: &402 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -48474,7 +49598,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *168 + reactions: *172 required: - author - body @@ -48494,7 +49618,7 @@ paths: - updated_at - url examples: - default: &743 + default: &756 value: - author: login: octocat @@ -48568,8 +49692,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *73 - - *330 + - *75 + - *340 requestBody: required: true content: @@ -48603,9 +49727,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: &391 + default: &403 value: author: login: octocat @@ -48677,9 +49801,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *73 - - *330 - - &392 + - *75 + - *340 + - &404 name: discussion_number description: The number that identifies the discussion. in: path @@ -48691,9 +49815,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: *391 + default: *403 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48715,9 +49839,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *73 - - *330 - - *392 + - *75 + - *340 + - *404 requestBody: required: false content: @@ -48740,9 +49864,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: &744 + default: &757 value: author: login: octocat @@ -48812,9 +49936,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *73 - - *330 - - *392 + - *75 + - *340 + - *404 responses: '204': description: Response @@ -48840,10 +49964,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *73 - - *330 - - *392 - - *91 + - *75 + - *340 + - *404 + - *93 - *17 - *19 responses: @@ -48853,7 +49977,7 @@ paths: application/json: schema: type: array - items: &393 + items: &405 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -48910,7 +50034,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *168 + reactions: *172 required: - author - body @@ -48925,7 +50049,7 @@ paths: - updated_at - url examples: - default: &745 + default: &758 value: - author: login: octocat @@ -48993,9 +50117,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *73 - - *330 - - *392 + - *75 + - *340 + - *404 requestBody: required: true content: @@ -49017,9 +50141,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: &394 + default: &406 value: author: login: octocat @@ -49085,10 +50209,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *73 - - *330 - - *392 - - &395 + - *75 + - *340 + - *404 + - &407 name: comment_number description: The number that identifies the comment. in: path @@ -49100,9 +50224,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: *394 + default: *406 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49124,10 +50248,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *73 - - *330 - - *392 - - *395 + - *75 + - *340 + - *404 + - *407 requestBody: required: true content: @@ -49149,9 +50273,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: &746 + default: &759 value: author: login: octocat @@ -49215,10 +50339,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *73 - - *330 - - *392 - - *395 + - *75 + - *340 + - *404 + - *407 responses: '204': description: Response @@ -49244,10 +50368,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *73 - - *330 - - *392 - - *395 + - *75 + - *340 + - *404 + - *407 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -49273,7 +50397,7 @@ paths: application/json: schema: type: array - items: &396 + items: &408 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -49316,7 +50440,7 @@ paths: - content - created_at examples: - default: &398 + default: &410 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -49366,10 +50490,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *73 - - *330 - - *392 - - *395 + - *75 + - *340 + - *404 + - *407 requestBody: required: true content: @@ -49402,9 +50526,9 @@ paths: team discussion comment content: application/json: - schema: *396 + schema: *408 examples: - default: &397 + default: &409 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -49433,9 +50557,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49458,11 +50582,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *73 - - *330 - - *392 - - *395 - - &399 + - *75 + - *340 + - *404 + - *407 + - &411 name: reaction_id description: The unique identifier of the reaction. in: path @@ -49494,9 +50618,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *73 - - *330 - - *392 + - *75 + - *340 + - *404 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -49522,9 +50646,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 x-github: @@ -49550,9 +50674,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *73 - - *330 - - *392 + - *75 + - *340 + - *404 requestBody: required: true content: @@ -49584,16 +50708,16 @@ paths: description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -49616,10 +50740,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *73 - - *330 - - *392 - - *399 + - *75 + - *340 + - *404 + - *411 responses: '204': description: Response @@ -49642,16 +50766,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '200': description: Response content: application/json: - schema: *400 + schema: *412 examples: - default: *401 + default: *413 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -49670,8 +50794,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - - *73 - - *330 + - *75 + - *340 requestBody: required: true content: @@ -49694,9 +50818,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *414 examples: - default: *403 + default: *415 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -49715,8 +50839,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '204': description: Response @@ -49740,8 +50864,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *73 - - *330 + - *75 + - *340 - *17 - *19 responses: @@ -49751,9 +50875,9 @@ paths: application/json: schema: type: array - items: *313 + items: *323 examples: - default: *314 + default: *324 headers: Link: *40 x-github: @@ -49775,8 +50899,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *73 - - *330 + - *75 + - *340 - name: role description: Filters members returned by their role in the team. in: query @@ -49799,7 +50923,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -49829,15 +50953,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *73 - - *330 - - *246 + - *75 + - *340 + - *256 responses: '200': description: Response content: application/json: - schema: &404 + schema: &416 title: Team Membership description: Team Membership type: object @@ -49864,7 +50988,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &747 + response-if-user-is-a-team-maintainer: &760 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -49900,9 +51024,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *73 - - *330 - - *246 + - *75 + - *340 + - *256 requestBody: required: false content: @@ -49927,9 +51051,9 @@ paths: description: Response content: application/json: - schema: *404 + schema: *416 examples: - response-if-users-membership-with-team-is-now-pending: &748 + response-if-users-membership-with-team-is-now-pending: &761 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -49964,9 +51088,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *73 - - *330 - - *246 + - *75 + - *340 + - *256 responses: '204': description: Response @@ -49991,8 +51115,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *73 - - *330 + - *75 + - *340 - *17 - *19 responses: @@ -50002,7 +51126,7 @@ paths: application/json: schema: type: array - items: &405 + items: &417 title: Team Project description: A team's access to a project. type: object @@ -50070,7 +51194,7 @@ paths: - updated_at - permissions examples: - default: &749 + default: &762 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -50133,9 +51257,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *73 - - *330 - - &406 + - *75 + - *340 + - &418 name: project_id description: The unique identifier of the project. in: path @@ -50147,9 +51271,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *417 examples: - default: &750 + default: &763 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -50211,9 +51335,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *73 - - *330 - - *406 + - *75 + - *340 + - *418 requestBody: required: false content: @@ -50279,9 +51403,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *73 - - *330 - - *406 + - *75 + - *340 + - *418 responses: '204': description: Response @@ -50308,8 +51432,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *73 - - *330 + - *75 + - *340 - *17 - *19 responses: @@ -50319,9 +51443,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -50350,16 +51474,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *73 - - *330 - - *407 - - *408 + - *75 + - *340 + - *419 + - *420 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &751 + schema: &764 title: Team Repository description: A team's access to a repository. type: object @@ -50382,8 +51506,8 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true forks: type: integer @@ -50928,10 +52052,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *73 - - *330 - - *407 - - *408 + - *75 + - *340 + - *419 + - *420 requestBody: required: false content: @@ -50976,10 +52100,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *73 - - *330 - - *407 - - *408 + - *75 + - *340 + - *419 + - *420 responses: '204': description: Response @@ -51005,16 +52129,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - - *73 - - *330 + - *75 + - *340 responses: '200': description: Response content: application/json: - schema: *409 + schema: *421 examples: - default: *410 + default: *422 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -51036,8 +52160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - - *73 - - *330 + - *75 + - *340 requestBody: required: true content: @@ -51080,7 +52204,7 @@ paths: description: Response content: application/json: - schema: *409 + schema: *421 examples: default: value: @@ -51112,8 +52236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *73 - - *330 + - *75 + - *340 - *17 - *19 responses: @@ -51123,9 +52247,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - response-if-child-teams-exist: &752 + response-if-child-teams-exist: &765 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -51178,7 +52302,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *73 + - *75 - name: security_product in: path description: The security feature to enable or disable. @@ -51252,7 +52376,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &411 + - &423 name: card_id description: The unique identifier of the card. in: path @@ -51264,7 +52388,7 @@ paths: description: Response content: application/json: - schema: &412 + schema: &424 title: Project Card description: Project cards represent a scope of work. type: object @@ -51331,7 +52455,7 @@ paths: - created_at - updated_at examples: - default: &413 + default: &425 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -51387,7 +52511,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *411 + - *423 requestBody: required: false content: @@ -51414,9 +52538,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *424 examples: - default: *413 + default: *425 '304': *37 '403': *29 '401': *25 @@ -51443,7 +52567,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *411 + - *423 responses: '204': description: Response @@ -51487,7 +52611,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *411 + - *423 requestBody: required: true content: @@ -51598,7 +52722,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &414 + - &426 name: column_id description: The unique identifier of the column. in: path @@ -51610,7 +52734,7 @@ paths: description: Response content: application/json: - schema: &415 + schema: &427 title: Project Column description: Project columns contain cards of work. type: object @@ -51656,7 +52780,7 @@ paths: - created_at - updated_at examples: - default: &416 + default: &428 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -51691,7 +52815,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *414 + - *426 requestBody: required: true content: @@ -51715,9 +52839,9 @@ paths: description: Response content: application/json: - schema: *415 + schema: *427 examples: - default: *416 + default: *428 '304': *37 '403': *29 '401': *25 @@ -51742,7 +52866,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *414 + - *426 responses: '204': description: Response @@ -51771,7 +52895,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *414 + - *426 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -51792,7 +52916,7 @@ paths: application/json: schema: type: array - items: *412 + items: *424 examples: default: value: @@ -51851,7 +52975,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *414 + - *426 requestBody: required: true content: @@ -51891,9 +53015,9 @@ paths: description: Response content: application/json: - schema: *412 + schema: *424 examples: - default: *413 + default: *425 '304': *37 '403': *29 '401': *25 @@ -51903,8 +53027,8 @@ paths: application/json: schema: oneOf: - - *207 - - *208 + - *217 + - *218 '503': description: Response content: @@ -51949,7 +53073,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *414 + - *426 requestBody: required: true content: @@ -52009,15 +53133,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#get-a-project parameters: - - *406 + - *418 responses: '200': description: Response content: application/json: - schema: *350 + schema: *360 examples: - default: &417 + default: &429 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -52074,7 +53198,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#update-a-project parameters: - - *406 + - *418 requestBody: required: false content: @@ -52120,9 +53244,9 @@ paths: description: Response content: application/json: - schema: *350 + schema: *360 examples: - default: *417 + default: *429 '404': description: Not Found if the authenticated user does not have access to the project @@ -52143,7 +53267,7 @@ paths: items: type: string '401': *25 - '410': *418 + '410': *430 '422': *7 x-github: githubCloudOnly: false @@ -52166,7 +53290,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#delete-a-project parameters: - - *406 + - *418 responses: '204': description: Delete Success @@ -52187,7 +53311,7 @@ paths: items: type: string '401': *25 - '410': *418 + '410': *430 '404': *6 x-github: githubCloudOnly: false @@ -52211,7 +53335,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *406 + - *418 - name: affiliation description: Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's @@ -52238,7 +53362,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '404': *6 @@ -52268,8 +53392,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *406 - - *246 + - *418 + - *256 requestBody: required: false content: @@ -52321,8 +53445,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *406 - - *246 + - *418 + - *256 responses: '204': description: Response @@ -52353,8 +53477,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#get-project-permission-for-a-user parameters: - - *406 - - *246 + - *418 + - *256 responses: '200': description: Response @@ -52427,7 +53551,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#list-project-columns parameters: - - *406 + - *418 - *17 - *19 responses: @@ -52437,7 +53561,7 @@ paths: application/json: schema: type: array - items: *415 + items: *427 examples: default: value: @@ -52475,7 +53599,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#create-a-project-column parameters: - - *406 + - *418 requestBody: required: true content: @@ -52498,7 +53622,7 @@ paths: description: Response content: application/json: - schema: *415 + schema: *427 examples: default: value: @@ -52563,7 +53687,7 @@ paths: resources: type: object properties: - core: &419 + core: &431 title: Rate Limit type: object properties: @@ -52580,21 +53704,21 @@ paths: - remaining - reset - used - graphql: *419 - search: *419 - code_search: *419 - source_import: *419 - integration_manifest: *419 - code_scanning_upload: *419 - actions_runner_registration: *419 - scim: *419 - dependency_snapshots: *419 - dependency_sbom: *419 - code_scanning_autofix: *419 + graphql: *431 + search: *431 + code_search: *431 + source_import: *431 + integration_manifest: *431 + code_scanning_upload: *431 + actions_runner_registration: *431 + scim: *431 + dependency_snapshots: *431 + dependency_sbom: *431 + code_scanning_autofix: *431 required: - core - search - rate: *419 + rate: *431 required: - rate - resources @@ -52698,14 +53822,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *420 + schema: *432 examples: default-response: summary: Default response @@ -53210,7 +54334,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *421 + '301': *433 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53228,8 +54352,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -53486,10 +54610,10 @@ paths: description: Response content: application/json: - schema: *420 + schema: *432 examples: - default: *422 - '307': &423 + default: *434 + '307': &435 description: Temporary Redirect content: application/json: @@ -53518,8 +54642,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -53541,9 +54665,9 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository - '307': *423 + '307': *435 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53565,11 +54689,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 - - &438 + - &450 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -53592,7 +54716,7 @@ paths: type: integer artifacts: type: array - items: &424 + items: &436 title: Artifact description: An artifact type: object @@ -53670,7 +54794,7 @@ paths: - expires_at - updated_at examples: - default: &439 + default: &451 value: total_count: 2 artifacts: @@ -53731,9 +54855,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *407 - - *408 - - &425 + - *419 + - *420 + - &437 name: artifact_id description: The unique identifier of the artifact. in: path @@ -53745,7 +54869,7 @@ paths: description: Response content: application/json: - schema: *424 + schema: *436 examples: default: value: @@ -53783,9 +54907,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *407 - - *408 - - *425 + - *419 + - *420 + - *437 responses: '204': description: Response @@ -53809,9 +54933,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *407 - - *408 - - *425 + - *419 + - *420 + - *437 - name: archive_format in: path required: true @@ -53825,7 +54949,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53848,14 +54972,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *426 + schema: *438 examples: default: value: @@ -53881,11 +55005,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 - - &427 + - &439 name: ref description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference @@ -53913,13 +55037,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *91 + - *93 responses: '200': description: Response content: application/json: - schema: &428 + schema: &440 title: Repository actions caches description: Repository actions caches type: object @@ -53961,7 +55085,7 @@ paths: - total_count - actions_caches examples: - default: &429 + default: &441 value: total_count: 1 actions_caches: @@ -53993,23 +55117,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *407 - - *408 + - *419 + - *420 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *427 + - *439 responses: '200': description: Response content: application/json: - schema: *428 + schema: *440 examples: - default: *429 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54029,8 +55153,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *407 - - *408 + - *419 + - *420 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -54061,9 +55185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *407 - - *408 - - &430 + - *419 + - *420 + - &442 name: job_id description: The unique identifier of the job. in: path @@ -54075,7 +55199,7 @@ paths: description: Response content: application/json: - schema: &442 + schema: &454 title: Job description: Information of a job execution in a workflow run type: object @@ -54382,9 +55506,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *407 - - *408 - - *430 + - *419 + - *420 + - *442 responses: '302': description: Response @@ -54412,9 +55536,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *407 - - *408 - - *430 + - *419 + - *420 + - *442 requestBody: required: false content: @@ -54435,7 +55559,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -54459,8 +55583,8 @@ paths: 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-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Status response @@ -54510,8 +55634,8 @@ paths: 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-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -54545,7 +55669,7 @@ paths: description: Empty response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -54574,8 +55698,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -54593,7 +55717,7 @@ paths: type: integer secrets: type: array - items: &444 + items: &456 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -54613,7 +55737,7 @@ paths: - created_at - updated_at examples: - default: &445 + default: &457 value: total_count: 2 secrets: @@ -54646,9 +55770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *407 - - *408 - - *431 + - *419 + - *420 + - *443 - *19 responses: '200': @@ -54665,7 +55789,7 @@ paths: type: integer variables: type: array - items: &448 + items: &460 title: Actions Variable type: object properties: @@ -54695,7 +55819,7 @@ paths: - created_at - updated_at examples: - default: &449 + default: &461 value: total_count: 2 variables: @@ -54728,8 +55852,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -54738,11 +55862,11 @@ paths: schema: type: object properties: - enabled: &432 + enabled: &444 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *49 - selected_actions_url: *217 + selected_actions_url: *227 required: - enabled examples: @@ -54771,8 +55895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -54783,7 +55907,7 @@ paths: schema: type: object properties: - enabled: *432 + enabled: *444 allowed_actions: *49 required: - enabled @@ -54814,14 +55938,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: &433 + schema: &445 type: object properties: access_level: @@ -54839,7 +55963,7 @@ paths: required: - access_level examples: - default: &434 + default: &446 value: access_level: organization x-github: @@ -54864,15 +55988,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: application/json: - schema: *433 + schema: *445 examples: - default: *434 + default: *446 responses: '204': description: Response @@ -54882,6 +56006,196 @@ paths: previews: [] category: actions subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for a repository + description: |- + Gets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository + 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-a-repository + parameters: + - *419 + - *420 + responses: + '200': + description: Response + content: + application/json: + schema: *201 + examples: + default: + value: + days: 90 + maximum_allowed_days: 365 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for a repository + description: |- + Sets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-repository + 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-a-repository + parameters: + - *419 + - *420 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *202 + examples: + default: + summary: Set retention days + value: + days: 90 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for a repository + description: |- + Gets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository + 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-a-repository + parameters: + - *419 + - *420 + responses: + '200': + description: Response + content: + application/json: + schema: *50 + examples: + default: *203 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for a repository + description: |- + Sets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository + 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-a-repository + parameters: + - *419 + - *420 + responses: + '204': + description: Response + '404': *6 + '422': *15 + requestBody: + required: true + content: + application/json: + schema: *50 + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for a repository + description: |- + Gets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository + 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-a-repository + parameters: + - *419 + - *420 + responses: + '200': + description: Response + content: + application/json: + schema: *204 + examples: + default: *51 + '403': *29 + '404': *6 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for a repository + description: |- + Sets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository + 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-a-repository + parameters: + - *419 + - *420 + requestBody: + required: true + content: + application/json: + schema: *205 + examples: + default: *51 + responses: + '204': + description: Empty response for successful settings update + '404': *6 + '422': *15 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/selected-actions": get: summary: Get allowed actions and reusable workflows for a repository @@ -54896,16 +56210,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *51 + schema: *53 examples: - default: *52 + default: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -54928,8 +56242,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -54937,9 +56251,9 @@ paths: required: false content: application/json: - schema: *51 + schema: *53 examples: - selected_actions: *52 + selected_actions: *54 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -54961,16 +56275,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *220 + schema: *230 examples: - default: *55 + default: *57 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54991,8 +56305,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Success response @@ -55003,9 +56317,9 @@ paths: required: true content: application/json: - schema: *221 + schema: *231 examples: - default: *55 + default: *57 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55032,8 +56346,8 @@ paths: in: query schema: type: string - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -55051,9 +56365,9 @@ paths: type: integer runners: type: array - items: *62 + items: *64 examples: - default: *63 + default: *65 headers: Link: *40 x-github: @@ -55077,8 +56391,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -55086,9 +56400,9 @@ paths: application/json: schema: type: array - items: *225 + items: *235 examples: - default: *226 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55110,8 +56424,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -55154,10 +56468,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *227 + '201': *237 '404': *6 '422': *7 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55185,16 +56499,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '201': description: Response content: application/json: - schema: *65 + schema: *67 examples: - default: *228 + default: *238 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55222,16 +56536,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '201': description: Response content: application/json: - schema: *65 + schema: *67 examples: - default: *229 + default: *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55253,17 +56567,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 responses: '200': description: Response content: application/json: - schema: *62 + schema: *64 examples: - default: *230 + default: *240 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55284,9 +56598,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 responses: '204': description: Response @@ -55312,11 +56626,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 responses: - '200': *67 + '200': *69 '404': *6 x-github: githubCloudOnly: false @@ -55338,9 +56652,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 requestBody: required: true content: @@ -55364,7 +56678,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -55388,9 +56702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 requestBody: required: true content: @@ -55415,7 +56729,7 @@ paths: - gpu - accelerated responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -55439,11 +56753,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 + - *419 + - *420 + - *63 responses: - '200': *231 + '200': *241 '404': *6 x-github: githubCloudOnly: false @@ -55470,12 +56784,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *407 - - *408 - - *61 - - *232 + - *419 + - *420 + - *63 + - *242 responses: - '200': *67 + '200': *69 '404': *6 '422': *7 x-github: @@ -55501,9 +56815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *407 - - *408 - - &452 + - *419 + - *420 + - &464 name: actor description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. @@ -55511,7 +56825,7 @@ paths: required: false schema: type: string - - &453 + - &465 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -55519,7 +56833,7 @@ paths: required: false schema: type: string - - &454 + - &466 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -55528,7 +56842,7 @@ paths: required: false schema: type: string - - &455 + - &467 name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status @@ -55555,7 +56869,7 @@ paths: - pending - *17 - *19 - - &456 + - &468 name: created description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." @@ -55564,7 +56878,7 @@ paths: schema: type: string format: date-time - - &435 + - &447 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -55573,13 +56887,13 @@ paths: schema: type: boolean default: false - - &457 + - &469 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &458 + - &470 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -55602,7 +56916,7 @@ paths: type: integer workflow_runs: type: array - items: &436 + items: &448 title: Workflow Run description: An invocation of a workflow type: object @@ -55697,7 +57011,7 @@ paths: that triggered the run. type: array nullable: true - items: &479 + items: &491 title: Pull Request Minimal type: object properties: @@ -55816,7 +57130,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &483 + properties: &495 id: type: string description: SHA for the commit @@ -55867,7 +57181,7 @@ paths: - name - email nullable: true - required: &484 + required: &496 - id - tree_id - message @@ -55875,8 +57189,8 @@ paths: - author - committer nullable: true - repository: *224 - head_repository: *224 + repository: *234 + head_repository: *234 head_repository_id: type: integer example: 5 @@ -55914,7 +57228,7 @@ paths: - workflow_url - pull_requests examples: - default: &459 + default: &471 value: total_count: 1 workflow_runs: @@ -56150,24 +57464,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *407 - - *408 - - &437 + - *419 + - *420 + - &449 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *435 + - *447 responses: '200': description: Response content: application/json: - schema: *436 + schema: *448 examples: - default: &440 + default: &452 value: id: 30433642 name: Build @@ -56408,9 +57722,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '204': description: Response @@ -56433,9 +57747,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '200': description: Response @@ -56554,15 +57868,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '201': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -56589,12 +57903,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 - *17 - *19 - - *438 + - *450 responses: '200': description: Response @@ -56610,9 +57924,9 @@ paths: type: integer artifacts: type: array - items: *424 + items: *436 examples: - default: *439 + default: *451 headers: Link: *40 x-github: @@ -56636,25 +57950,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *407 - - *408 - - *437 - - &441 + - *419 + - *420 + - *449 + - &453 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *435 + - *447 responses: '200': description: Response content: application/json: - schema: *436 + schema: *448 examples: - default: *440 + default: *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56677,10 +57991,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *407 - - *408 - - *437 - - *441 + - *419 + - *420 + - *449 + - *453 - *17 - *19 responses: @@ -56698,9 +58012,9 @@ paths: type: integer jobs: type: array - items: *442 + items: *454 examples: - default: &443 + default: &455 value: total_count: 1 jobs: @@ -56813,10 +58127,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *407 - - *408 - - *437 - - *441 + - *419 + - *420 + - *449 + - *453 responses: '302': description: Response @@ -56844,19 +58158,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '202': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56879,9 +58193,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 requestBody: required: true content: @@ -56948,19 +58262,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '202': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56983,9 +58297,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 - name: filter description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all @@ -57015,9 +58329,9 @@ paths: type: integer jobs: type: array - items: *442 + items: *454 examples: - default: *443 + default: *455 headers: Link: *40 x-github: @@ -57042,9 +58356,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '302': description: Response @@ -57071,14 +58385,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '204': description: Response '403': *29 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57100,9 +58414,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '200': description: Response @@ -57162,7 +58476,7 @@ paths: items: type: object properties: - type: &569 + type: &581 type: string description: The type of reviewer. enum: @@ -57172,7 +58486,7 @@ paths: reviewer: anyOf: - *4 - - *255 + - *265 required: - environment - wait_timer @@ -57247,9 +58561,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 requestBody: required: true content: @@ -57296,7 +58610,7 @@ paths: application/json: schema: type: array - items: &555 + items: &567 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -57384,8 +58698,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 required: - id - node_id @@ -57402,7 +58716,7 @@ paths: - created_at - updated_at examples: - default: &556 + default: &568 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -57458,9 +58772,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 requestBody: required: false content: @@ -57481,7 +58795,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -57504,9 +58818,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 requestBody: required: false content: @@ -57527,7 +58841,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -57560,9 +58874,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *407 - - *408 - - *437 + - *419 + - *420 + - *449 responses: '200': description: Response @@ -57699,8 +59013,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -57718,9 +59032,9 @@ paths: type: integer secrets: type: array - items: *444 + items: *456 examples: - default: *445 + default: *457 headers: Link: *40 x-github: @@ -57745,16 +59059,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *446 + schema: *458 examples: - default: *447 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57776,17 +59090,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '200': description: Response content: application/json: - schema: *444 + schema: *456 examples: - default: &582 + default: &594 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -57812,9 +59126,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 requestBody: required: true content: @@ -57845,7 +59159,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -57871,9 +59185,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '204': description: Response @@ -57898,9 +59212,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *407 - - *408 - - *431 + - *419 + - *420 + - *443 - *19 responses: '200': @@ -57917,9 +59231,9 @@ paths: type: integer variables: type: array - items: *448 + items: *460 examples: - default: *449 + default: *461 headers: Link: *40 x-github: @@ -57942,8 +59256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -57970,7 +59284,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -57995,17 +59309,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *407 - - *408 - - *237 + - *419 + - *420 + - *247 responses: '200': description: Response content: application/json: - schema: *448 + schema: *460 examples: - default: &583 + default: &595 value: name: USERNAME value: octocat @@ -58031,9 +59345,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *407 - - *408 - - *237 + - *419 + - *420 + - *247 requestBody: required: true content: @@ -58075,9 +59389,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *407 - - *408 - - *237 + - *419 + - *420 + - *247 responses: '204': description: Response @@ -58102,8 +59416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -58121,7 +59435,7 @@ paths: type: integer workflows: type: array - items: &450 + items: &462 title: Workflow description: A GitHub Actions workflow type: object @@ -58228,9 +59542,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *407 - - *408 - - &451 + - *419 + - *420 + - &463 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -58245,7 +59559,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *462 examples: default: value: @@ -58278,9 +59592,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *407 - - *408 - - *451 + - *419 + - *420 + - *463 responses: '204': description: Response @@ -58305,9 +59619,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *407 - - *408 - - *451 + - *419 + - *420 + - *463 responses: '204': description: Response @@ -58358,9 +59672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *407 - - *408 - - *451 + - *419 + - *420 + - *463 responses: '204': description: Response @@ -58387,19 +59701,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *407 - - *408 - - *451 - - *452 - - *453 - - *454 - - *455 + - *419 + - *420 + - *463 + - *464 + - *465 + - *466 + - *467 - *17 - *19 - - *456 - - *435 - - *457 - - *458 + - *468 + - *447 + - *469 + - *470 responses: '200': description: Response @@ -58415,9 +59729,9 @@ paths: type: integer workflow_runs: type: array - items: *436 + items: *448 examples: - default: *459 + default: *471 headers: Link: *40 x-github: @@ -58450,9 +59764,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *407 - - *408 - - *451 + - *419 + - *420 + - *463 responses: '200': description: Response @@ -58513,12 +59827,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *407 - - *408 - - *91 + - *419 + - *420 + - *93 - *17 - - *89 - - *90 + - *91 + - *92 - name: ref description: |- The Git reference for the activities you want to list. @@ -58678,8 +59992,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -58691,7 +60005,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '404': *6 @@ -58716,8 +60030,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *407 - - *408 + - *419 + - *420 - name: assignee in: path required: true @@ -58753,8 +60067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -58866,11 +60180,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *407 - - *408 + - *419 + - *420 - *17 - - *89 - - *90 + - *91 + - *92 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -58921,7 +60235,7 @@ paths: bundle_url: type: string examples: - default: *460 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58941,8 +60255,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -58950,7 +60264,7 @@ paths: application/json: schema: type: array - items: &461 + items: &473 title: Autolink reference description: An autolink reference. type: object @@ -59000,8 +60314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -59040,9 +60354,9 @@ paths: description: response content: application/json: - schema: *461 + schema: *473 examples: - default: &462 + default: &474 value: id: 1 key_prefix: TICKET- @@ -59073,9 +60387,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *407 - - *408 - - &463 + - *419 + - *420 + - &475 name: autolink_id description: The unique identifier of the autolink. in: path @@ -59087,9 +60401,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *473 examples: - default: *462 + default: *474 '404': *6 x-github: githubCloudOnly: false @@ -59109,9 +60423,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *407 - - *408 - - *463 + - *419 + - *420 + - *475 responses: '204': description: Response @@ -59135,8 +60449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response if Dependabot is enabled @@ -59184,8 +60498,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -59206,8 +60520,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -59227,8 +60541,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *407 - - *408 + - *419 + - *420 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -59266,7 +60580,7 @@ paths: - url protected: type: boolean - protection: &465 + protection: &477 title: Branch Protection description: Branch Protection type: object @@ -59308,7 +60622,7 @@ paths: required: - contexts - checks - enforce_admins: &468 + enforce_admins: &480 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -59323,7 +60637,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &470 + required_pull_request_reviews: &482 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -59344,7 +60658,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *255 + items: *265 apps: description: The list of apps with review dismissal access. @@ -59373,7 +60687,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *255 + items: *265 apps: description: The list of apps allowed to bypass pull request requirements. @@ -59399,7 +60713,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &467 + restrictions: &479 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -59706,9 +61020,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *407 - - *408 - - &466 + - *419 + - *420 + - &478 name: branch description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-cloud@latest//graphql). @@ -59722,14 +61036,14 @@ paths: description: Response content: application/json: - schema: &476 + schema: &488 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &528 + commit: &540 title: Commit description: Commit type: object @@ -59763,7 +61077,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &464 + properties: &476 name: type: string example: '"Chris Wanstrath"' @@ -59778,7 +61092,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *464 + properties: *476 nullable: true message: type: string @@ -59799,7 +61113,7 @@ paths: required: - sha - url - verification: &589 + verification: &601 title: Verification type: object properties: @@ -59833,12 +61147,12 @@ paths: nullable: true oneOf: - *4 - - *235 + - *245 committer: nullable: true oneOf: - *4 - - *235 + - *245 parents: type: array items: @@ -59869,7 +61183,7 @@ paths: type: integer files: type: array - items: &543 + items: &555 title: Diff Entry description: Diff Entry type: object @@ -59952,7 +61266,7 @@ paths: - self protected: type: boolean - protection: *465 + protection: *477 protection_url: type: string format: uri @@ -60059,7 +61373,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *421 + '301': *433 '404': *6 x-github: githubCloudOnly: false @@ -60081,15 +61395,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *465 + schema: *477 examples: default: value: @@ -60283,9 +61597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -60540,7 +61854,7 @@ paths: url: type: string format: uri - required_status_checks: &473 + required_status_checks: &485 title: Status Check Policy description: Status Check Policy type: object @@ -60616,7 +61930,7 @@ paths: items: *4 teams: type: array - items: *255 + items: *265 apps: type: array items: *5 @@ -60634,7 +61948,7 @@ paths: items: *4 teams: type: array - items: *255 + items: *265 apps: type: array items: *5 @@ -60692,7 +62006,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *467 + restrictions: *479 required_conversation_resolution: type: object properties: @@ -60804,9 +62118,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -60831,17 +62145,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *468 + schema: *480 examples: - default: &469 + default: &481 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -60863,17 +62177,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *468 + schema: *480 examples: - default: *469 + default: *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60892,9 +62206,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -60919,17 +62233,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *470 + schema: *482 examples: - default: &471 + default: &483 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -61025,9 +62339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -61125,9 +62439,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *482 examples: - default: *471 + default: *483 '422': *15 x-github: githubCloudOnly: false @@ -61148,9 +62462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -61177,17 +62491,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *468 + schema: *480 examples: - default: &472 + default: &484 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -61210,17 +62524,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *468 + schema: *480 examples: - default: *472 + default: *484 '404': *6 x-github: githubCloudOnly: false @@ -61240,9 +62554,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -61267,17 +62581,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *473 + schema: *485 examples: - default: &474 + default: &486 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -61303,9 +62617,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -61357,9 +62671,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *485 examples: - default: *474 + default: *486 '404': *6 '422': *15 x-github: @@ -61381,9 +62695,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -61407,9 +62721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response @@ -61443,9 +62757,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -61512,9 +62826,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -61578,9 +62892,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: content: application/json: @@ -61646,15 +62960,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response content: application/json: - schema: *467 + schema: *479 examples: default: value: @@ -61745,9 +63059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '204': description: Response @@ -61770,9 +63084,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response @@ -61782,7 +63096,7 @@ paths: type: array items: *5 examples: - default: &475 + default: &487 value: - id: 1 slug: octoapp @@ -61839,9 +63153,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -61875,7 +63189,7 @@ paths: type: array items: *5 examples: - default: *475 + default: *487 '422': *15 x-github: githubCloudOnly: false @@ -61896,9 +63210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -61932,7 +63246,7 @@ paths: type: array items: *5 examples: - default: *475 + default: *487 '422': *15 x-github: githubCloudOnly: false @@ -61953,9 +63267,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -61989,7 +63303,7 @@ paths: type: array items: *5 examples: - default: *475 + default: *487 '422': *15 x-github: githubCloudOnly: false @@ -62011,9 +63325,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response @@ -62021,9 +63335,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 '404': *6 x-github: githubCloudOnly: false @@ -62043,9 +63357,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -62081,9 +63395,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 '422': *15 x-github: githubCloudOnly: false @@ -62104,9 +63418,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: false content: @@ -62142,9 +63456,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 '422': *15 x-github: githubCloudOnly: false @@ -62165,9 +63479,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: content: application/json: @@ -62202,9 +63516,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 '422': *15 x-github: githubCloudOnly: false @@ -62226,9 +63540,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 responses: '200': description: Response @@ -62238,7 +63552,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 '404': *6 x-github: githubCloudOnly: false @@ -62262,9 +63576,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -62297,7 +63611,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 '422': *15 x-github: githubCloudOnly: false @@ -62322,9 +63636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -62357,7 +63671,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 '422': *15 x-github: githubCloudOnly: false @@ -62382,9 +63696,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -62417,7 +63731,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 '422': *15 x-github: githubCloudOnly: false @@ -62444,9 +63758,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 requestBody: required: true content: @@ -62468,7 +63782,7 @@ paths: description: Response content: application/json: - schema: *476 + schema: *488 examples: default: value: @@ -62582,12 +63896,12 @@ paths: category: repos subcategory: bypass-requests parameters: - - *407 - - *408 - - *247 - - *248 - - *249 - - *250 + - *419 + - *420 + - *257 + - *258 + - *259 + - *260 - *17 - *19 responses: @@ -62597,11 +63911,11 @@ paths: application/json: schema: type: array - items: *251 + items: *261 examples: - default: *252 + default: *262 '404': *6 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": get: summary: Get a repository push bypass request @@ -62619,8 +63933,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: bypass_request_number in: path required: true @@ -62634,7 +63948,7 @@ paths: description: Response content: application/json: - schema: *251 + schema: *261 examples: default: value: @@ -62672,7 +63986,7 @@ paths: url: https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2 html_url: https://github.com/octo-org/smile/exemptions/2 '404': *6 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/bypass-requests/secret-scanning": get: summary: List bypass requests for secret scanning for a repository @@ -62693,12 +64007,12 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *407 - - *408 - - *247 - - *248 - - *249 - - *250 + - *419 + - *420 + - *257 + - *258 + - *259 + - *260 - *17 - *19 responses: @@ -62708,12 +64022,12 @@ paths: application/json: schema: type: array - items: *477 + items: *489 examples: - default: *478 + default: *490 '404': *6 '403': *29 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}": get: summary: Get a bypass request for secret scanning @@ -62734,8 +64048,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *407 - - *408 + - *419 + - *420 - name: bypass_request_number in: path required: true @@ -62747,7 +64061,7 @@ paths: description: A single bypass request. content: application/json: - schema: *477 + schema: *489 examples: default: value: @@ -62785,7 +64099,7 @@ paths: html_url: https://github.com/octo-org/smile/exemptions/1 '404': *6 '403': *29 - '500': *88 + '500': *90 patch: summary: Review a bypass request for secret scanning description: |- @@ -62805,8 +64119,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *407 - - *408 + - *419 + - *420 - name: bypass_request_number in: path required: true @@ -62856,7 +64170,7 @@ paths: '404': *6 '403': *29 '422': *15 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/bypass-responses/secret-scanning/{bypass_response_id}": delete: summary: Dismiss a response on a bypass request for secret scanning @@ -62877,8 +64191,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *407 - - *408 + - *419 + - *420 - name: bypass_response_id in: path required: true @@ -62891,7 +64205,7 @@ paths: '404': *6 '403': *29 '422': *15 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/check-runs": post: summary: Create a check run @@ -62911,8 +64225,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -63191,7 +64505,7 @@ paths: description: Response content: application/json: - schema: &480 + schema: &492 title: CheckRun description: A check performed on the code of a given code change type: object @@ -63302,16 +64616,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *479 - deployment: &806 + items: *491 + deployment: &818 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -63378,8 +64692,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 required: - id - node_id @@ -63591,9 +64905,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *407 - - *408 - - &481 + - *419 + - *420 + - &493 name: check_run_id description: The unique identifier of the check run. in: path @@ -63605,9 +64919,9 @@ paths: description: Response content: application/json: - schema: *480 + schema: *492 examples: - default: &482 + default: &494 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -63707,9 +65021,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *407 - - *408 - - *481 + - *419 + - *420 + - *493 requestBody: required: true content: @@ -63949,9 +65263,9 @@ paths: description: Response content: application/json: - schema: *480 + schema: *492 examples: - default: *482 + default: *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63971,9 +65285,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *407 - - *408 - - *481 + - *419 + - *420 + - *493 - *17 - *19 responses: @@ -64068,15 +65382,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *407 - - *408 - - *481 + - *419 + - *420 + - *493 responses: '201': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -64114,8 +65428,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -64137,7 +65451,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &485 + schema: &497 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -64201,7 +65515,7 @@ paths: nullable: true pull_requests: type: array - items: *479 + items: *491 nullable: true app: title: GitHub app @@ -64212,9 +65526,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 - repository: *224 + properties: *169 + required: *170 + repository: *234 created_at: type: string format: date-time @@ -64223,12 +65537,12 @@ paths: type: string format: date-time nullable: true - head_commit: &832 + head_commit: &844 title: Simple Commit description: A commit. type: object - properties: *483 - required: *484 + properties: *495 + required: *496 latest_check_runs_count: type: integer check_runs_url: @@ -64256,7 +65570,7 @@ paths: - check_runs_url - pull_requests examples: - default: &486 + default: &498 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -64547,9 +65861,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *485 + schema: *497 examples: - default: *486 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64568,8 +65882,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -64630,7 +65944,7 @@ paths: required: - app_id - setting - repository: *224 + repository: *234 examples: default: value: @@ -64878,9 +66192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *407 - - *408 - - &487 + - *419 + - *420 + - &499 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -64892,9 +66206,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *497 examples: - default: *486 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64917,17 +66231,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *407 - - *408 - - *487 - - &536 + - *419 + - *420 + - *499 + - &548 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &537 + - &549 name: status description: Returns check runs with the specified `status`. in: query @@ -64966,9 +66280,9 @@ paths: type: integer check_runs: type: array - items: *480 + items: *492 examples: - default: &538 + default: &550 value: total_count: 1 check_runs: @@ -65070,15 +66384,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *407 - - *408 - - *487 + - *419 + - *420 + - *499 responses: '201': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -65105,30 +66419,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *407 - - *408 - - *259 - - *260 + - *419 + - *420 + - *269 + - *270 - *19 - *17 - - &503 + - &515 name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. in: query required: false - schema: *488 - - &504 + schema: *500 + - &516 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer + - *93 - *91 - - *89 - - *90 + - *92 - name: sort description: The property by which to sort the results. in: query @@ -65144,13 +66458,13 @@ paths: be returned. in: query required: false - schema: *261 + schema: *271 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *489 + schema: *501 responses: '200': description: Response @@ -65161,14 +66475,14 @@ paths: items: type: object properties: - number: *103 - created_at: *110 - updated_at: *111 - url: *108 - html_url: *109 - instances_url: *490 - state: *94 - fixed_at: *113 + number: *105 + created_at: *112 + updated_at: *113 + url: *110 + html_url: *111 + instances_url: *502 + state: *96 + fixed_at: *115 dismissed_by: title: Simple User description: A GitHub user. @@ -65176,12 +66490,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *112 - dismissed_reason: *491 - dismissed_comment: *492 - rule: *493 - tool: *494 - most_recent_instance: *495 + dismissed_at: *114 + dismissed_reason: *503 + dismissed_comment: *504 + rule: *505 + tool: *506 + most_recent_instance: *507 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -65304,14 +66618,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &496 + '403': &508 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65331,9 +66645,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *407 - - *408 - - &497 + - *419 + - *420 + - &509 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -65341,23 +66655,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *103 + schema: *105 responses: '200': description: Response content: application/json: - schema: &498 + schema: &510 type: object properties: - number: *103 - created_at: *110 - updated_at: *111 - url: *108 - html_url: *109 - instances_url: *490 - state: *94 - fixed_at: *113 + number: *105 + created_at: *112 + updated_at: *113 + url: *110 + html_url: *111 + instances_url: *502 + state: *96 + fixed_at: *115 dismissed_by: title: Simple User description: A GitHub user. @@ -65365,9 +66679,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *112 - dismissed_reason: *491 - dismissed_comment: *492 + dismissed_at: *114 + dismissed_reason: *503 + dismissed_comment: *504 rule: type: object properties: @@ -65421,8 +66735,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *494 - most_recent_instance: *495 + tool: *506 + most_recent_instance: *507 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -65518,9 +66832,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65538,9 +66852,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 requestBody: required: true content: @@ -65555,8 +66869,8 @@ paths: enum: - open - dismissed - dismissed_reason: *491 - dismissed_comment: *492 + dismissed_reason: *503 + dismissed_comment: *504 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -65575,7 +66889,7 @@ paths: description: Response content: application/json: - schema: *498 + schema: *510 examples: default: value: @@ -65651,14 +66965,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &502 + '403': &514 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -65678,15 +66992,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 responses: '200': description: Response content: application/json: - schema: &499 + schema: &511 type: object properties: status: @@ -65712,13 +67026,13 @@ paths: - description - started_at examples: - default: &500 + default: &512 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &501 + '400': &513 description: Bad Request content: application/json: @@ -65729,9 +67043,9 @@ paths: message: The alert_number is not valid documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert status: '400' - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65754,29 +67068,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 responses: '200': description: OK content: application/json: - schema: *499 + schema: *511 examples: - default: *500 + default: *512 '202': description: Accepted content: application/json: - schema: *499 + schema: *511 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *501 + '400': *513 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -65786,7 +67100,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65808,9 +67122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 requestBody: required: false content: @@ -65855,12 +67169,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *501 - '403': *502 + '400': *513 + '403': *514 '404': *6 '422': description: Unprocessable Entity - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65880,13 +67194,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 - *19 - *17 - - *503 - - *504 + - *515 + - *516 responses: '200': description: Response @@ -65894,7 +67208,7 @@ paths: application/json: schema: type: array - items: *495 + items: *507 examples: default: value: @@ -65933,9 +67247,9 @@ paths: end_column: 50 classifications: - source - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65967,29 +67281,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *407 - - *408 - - *259 - - *260 + - *419 + - *420 + - *269 + - *270 - *19 - *17 - - *504 + - *516 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. required: false - schema: *488 + schema: *500 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &507 + schema: &519 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *91 + - *93 - name: sort description: The property by which to sort the results. in: query @@ -66006,23 +67320,23 @@ paths: application/json: schema: type: array - items: &508 + items: &520 type: object properties: - ref: *488 - commit_sha: &516 + ref: *500 + commit_sha: &528 description: The SHA of the commit to which the analysis you are uploading relates. type: string minLength: 40 maxLength: 40 pattern: "^[0-9a-fA-F]+$" - analysis_key: *505 + analysis_key: *517 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *506 + category: *518 error: type: string example: error reading field xyz @@ -66046,8 +67360,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *507 - tool: *494 + sarif_id: *519 + tool: *506 deletable: type: boolean warning: @@ -66108,9 +67422,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -66144,8 +67458,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -66158,7 +67472,7 @@ paths: description: Response content: application/json: - schema: *508 + schema: *520 examples: response: summary: application/json response @@ -66212,14 +67526,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *496 + '403': *508 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -66299,8 +67613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -66353,9 +67667,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *502 + '403': *514 '404': *6 - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -66375,8 +67689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -66384,7 +67698,7 @@ paths: application/json: schema: type: array - items: &509 + items: &521 title: CodeQL Database description: A CodeQL database. type: object @@ -66495,9 +67809,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66524,8 +67838,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: language in: path description: The language of the CodeQL database. @@ -66537,7 +67851,7 @@ paths: description: Response content: application/json: - schema: *509 + schema: *521 examples: default: value: @@ -66569,11 +67883,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &545 + '302': &557 description: Found - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66593,8 +67907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *407 - - *408 + - *419 + - *420 - name: language in: path description: The language of the CodeQL database. @@ -66604,9 +67918,9 @@ paths: responses: '204': description: Response - '403': *502 + '403': *514 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66632,8 +67946,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -66642,7 +67956,7 @@ paths: type: object additionalProperties: false properties: - language: &510 + language: &522 type: string description: The language targeted by the CodeQL query enum: @@ -66721,7 +68035,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &514 + schema: &526 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -66729,9 +68043,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *100 + controller_repo: *102 actor: *4 - query_language: *510 + query_language: *522 query_pack_url: type: string description: The download url for the query pack. @@ -66778,7 +68092,7 @@ paths: items: type: object properties: - repository: &511 + repository: &523 title: Repository Identifier description: Repository Identifier type: object @@ -66814,7 +68128,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &515 + analysis_status: &527 type: string description: The new status of the CodeQL variant analysis repository task. @@ -66846,7 +68160,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &512 + access_mismatch_repos: &524 type: object properties: repository_count: @@ -66860,7 +68174,7 @@ paths: This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. - items: *511 + items: *523 required: - repository_count - repositories @@ -66882,8 +68196,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *512 - over_limit_repos: *512 + no_codeql_db_repos: *524 + over_limit_repos: *524 required: - access_mismatch_repos - not_found_repos @@ -66899,7 +68213,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &513 + value: &525 summary: Default response value: id: 1 @@ -67051,17 +68365,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *513 + value: *525 repository_lists: summary: Response for a successful variant analysis submission - value: *513 + value: *525 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67082,8 +68396,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *407 - - *408 + - *419 + - *420 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -67095,11 +68409,11 @@ paths: description: Response content: application/json: - schema: *514 + schema: *526 examples: - default: *513 + default: *525 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67120,7 +68434,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *407 + - *419 - name: repo in: path description: The name of the controller repository. @@ -67154,8 +68468,8 @@ paths: schema: type: object properties: - repository: *100 - analysis_status: *515 + repository: *102 + analysis_status: *527 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -67259,7 +68573,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67280,8 +68594,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -67366,9 +68680,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *496 + '403': *508 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67387,8 +68701,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -67455,7 +68769,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -67480,7 +68794,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *502 + '403': *514 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -67494,7 +68808,7 @@ paths: content: application/json: schema: *3 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67551,8 +68865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -67560,7 +68874,7 @@ paths: schema: type: object properties: - commit_sha: *516 + commit_sha: *528 ref: type: string description: |- @@ -67618,7 +68932,7 @@ paths: schema: type: object properties: - id: *507 + id: *519 url: type: string description: The REST API URL for checking the status of the upload. @@ -67632,11 +68946,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *502 + '403': *514 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -67655,8 +68969,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *407 - - *408 + - *419 + - *420 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -67702,10 +69016,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *496 + '403': *508 '404': description: Not Found if the sarif id does not match any upload - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -67727,8 +69041,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -67752,7 +69066,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *95 + configuration: *97 examples: default: value: @@ -67784,7 +69098,7 @@ paths: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - '204': *123 + '204': *125 '304': *37 '403': *29 '404': *6 @@ -67809,8 +69123,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *407 - - *408 + - *419 + - *420 - name: ref description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch @@ -67930,8 +69244,8 @@ paths: parameters: - *17 - *19 - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -67947,7 +69261,7 @@ paths: type: integer codespaces: type: array - items: *322 + items: *332 examples: default: value: @@ -68223,7 +69537,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': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -68245,8 +69559,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -68309,22 +69623,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '400': *14 '401': *25 '403': *29 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68348,8 +69662,8 @@ paths: parameters: - *17 - *19 - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -68389,7 +69703,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *88 + '500': *90 '400': *14 '401': *25 '403': *29 @@ -68413,8 +69727,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -68449,14 +69763,14 @@ paths: type: integer machines: type: array - items: &759 + items: &772 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *518 - required: *519 + properties: *530 + required: *531 examples: - default: &760 + default: &773 value: total_count: 2 machines: @@ -68473,7 +69787,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -68496,8 +69810,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *407 - - *408 + - *419 + - *420 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -68581,8 +69895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *407 - - *408 + - *419 + - *420 - name: ref description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically @@ -68627,7 +69941,7 @@ paths: '403': *29 '404': *6 '422': *15 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68648,8 +69962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -68667,7 +69981,7 @@ paths: type: integer secrets: type: array - items: &523 + items: &535 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -68687,7 +70001,7 @@ paths: - created_at - updated_at examples: - default: *520 + default: *532 headers: Link: *40 x-github: @@ -68710,16 +70024,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *521 + schema: *533 examples: - default: *522 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68739,17 +70053,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '200': description: Response content: application/json: - schema: *523 + schema: *535 examples: - default: *524 + default: *536 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68769,9 +70083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 requestBody: required: true content: @@ -68799,7 +70113,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -68823,9 +70137,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '204': description: Response @@ -68853,8 +70167,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *407 - - *408 + - *419 + - *420 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -68896,7 +70210,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &525 + properties: &537 login: type: string example: octocat @@ -68989,7 +70303,7 @@ paths: user_view_type: type: string example: public - required: &526 + required: &538 - avatar_url - events_url - followers_url @@ -69063,9 +70377,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *407 - - *408 - - *246 + - *419 + - *420 + - *256 responses: '204': description: Response if user is a collaborator @@ -69111,9 +70425,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *407 - - *408 - - *246 + - *419 + - *420 + - *256 requestBody: required: false content: @@ -69139,7 +70453,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &602 + schema: &614 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -69150,7 +70464,7 @@ paths: example: 42 type: integer format: int64 - repository: *224 + repository: *234 invitee: title: Simple User description: A GitHub user. @@ -69328,7 +70642,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *207 + schema: *217 '403': *29 x-github: triggersNotification: true @@ -69368,9 +70682,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *407 - - *408 - - *246 + - *419 + - *420 + - *256 responses: '204': description: No Content when collaborator was removed from the repository. @@ -69401,9 +70715,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *407 - - *408 - - *246 + - *419 + - *420 + - *256 responses: '200': description: if user has admin permissions @@ -69423,8 +70737,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *525 - required: *526 + properties: *537 + required: *538 nullable: true required: - permission @@ -69479,8 +70793,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -69490,7 +70804,7 @@ paths: application/json: schema: type: array - items: &527 + items: &539 title: Commit Comment description: Commit Comment type: object @@ -69531,8 +70845,8 @@ paths: updated_at: type: string format: date-time - author_association: *167 - reactions: *168 + author_association: *171 + reactions: *172 required: - url - html_url @@ -69548,7 +70862,7 @@ paths: - created_at - updated_at examples: - default: &530 + default: &542 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69607,17 +70921,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '200': description: Response content: application/json: - schema: *527 + schema: *539 examples: - default: &531 + default: &543 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -69674,9 +70988,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -69698,7 +71012,7 @@ paths: description: Response content: application/json: - schema: *527 + schema: *539 examples: default: value: @@ -69749,9 +71063,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '204': description: Response @@ -69772,9 +71086,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -69800,9 +71114,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 '404': *6 @@ -69823,9 +71137,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -69857,16 +71171,16 @@ paths: description: Reaction exists content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Reaction created content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '422': *15 x-github: githubCloudOnly: false @@ -69888,10 +71202,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *407 - - *408 - - *179 - - *399 + - *419 + - *420 + - *183 + - *411 responses: '204': description: Response @@ -69940,8 +71254,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *407 - - *408 + - *419 + - *420 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -69997,9 +71311,9 @@ paths: application/json: schema: type: array - items: *528 + items: *540 examples: - default: &653 + default: &665 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -70070,10 +71384,10 @@ paths: sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: Link: *40 - '500': *88 + '500': *90 '400': *14 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70093,9 +71407,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *407 - - *408 - - &529 + - *419 + - *420 + - &541 name: commit_sha description: The SHA of the commit. in: path @@ -70142,7 +71456,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70167,9 +71481,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *407 - - *408 - - *529 + - *419 + - *420 + - *541 - *17 - *19 responses: @@ -70179,9 +71493,9 @@ paths: application/json: schema: type: array - items: *527 + items: *539 examples: - default: *530 + default: *542 headers: Link: *40 x-github: @@ -70209,9 +71523,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *407 - - *408 - - *529 + - *419 + - *420 + - *541 requestBody: required: true content: @@ -70246,9 +71560,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *539 examples: - default: *531 + default: *543 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -70276,9 +71590,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *407 - - *408 - - *529 + - *419 + - *420 + - *541 - *17 - *19 responses: @@ -70288,7 +71602,7 @@ paths: application/json: schema: type: array - items: &644 + items: &656 title: Pull Request Simple description: Pull Request Simple type: object @@ -70394,8 +71708,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *532 - required: *533 + properties: *544 + required: *545 nullable: true active_lock_reason: type: string @@ -70440,7 +71754,7 @@ paths: nullable: true requested_teams: type: array - items: *255 + items: *265 nullable: true head: type: object @@ -70449,7 +71763,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *66 sha: type: string user: @@ -70472,7 +71786,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *66 sha: type: string user: @@ -70491,7 +71805,7 @@ paths: _links: type: object properties: - comments: &534 + comments: &546 title: Link description: Hypermedia Link type: object @@ -70500,13 +71814,13 @@ paths: type: string required: - href - commits: *534 - statuses: *534 - html: *534 - issue: *534 - review_comments: *534 - review_comment: *534 - self: *534 + commits: *546 + statuses: *546 + html: *546 + issue: *546 + review_comments: *546 + review_comment: *546 + self: *546 required: - comments - commits @@ -70516,8 +71830,8 @@ paths: - review_comments - review_comment - self - author_association: *167 - auto_merge: &646 + author_association: *171 + auto_merge: &658 title: Auto merge description: The status of auto merging a pull request. type: object @@ -70580,7 +71894,7 @@ paths: - author_association - auto_merge examples: - default: &645 + default: &657 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -71060,7 +72374,7 @@ paths: draft: false headers: Link: *40 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71117,11 +72431,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *407 - - *408 + - *419 + - *420 - *19 - *17 - - &535 + - &547 name: ref description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" @@ -71136,9 +72450,9 @@ paths: description: Response content: application/json: - schema: *528 + schema: *540 examples: - default: &631 + default: &643 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -71224,9 +72538,9 @@ paths: ..... '422': *15 '404': *6 - '500': *88 - '503': *157 - '409': *99 + '500': *90 + '503': *159 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71251,11 +72565,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *407 - - *408 - - *535 - - *536 - - *537 + - *419 + - *420 + - *547 + - *548 + - *549 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -71289,9 +72603,9 @@ paths: type: integer check_runs: type: array - items: *480 + items: *492 examples: - default: *538 + default: *550 headers: Link: *40 x-github: @@ -71316,9 +72630,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *407 - - *408 - - *535 + - *419 + - *420 + - *547 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -71326,7 +72640,7 @@ paths: schema: type: integer example: 1 - - *536 + - *548 - *17 - *19 responses: @@ -71344,7 +72658,7 @@ paths: type: integer check_suites: type: array - items: *485 + items: *497 examples: default: value: @@ -71544,9 +72858,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *407 - - *408 - - *535 + - *419 + - *420 + - *547 - *17 - *19 responses: @@ -71613,7 +72927,7 @@ paths: type: string total_count: type: integer - repository: *224 + repository: *234 commit_url: type: string format: uri @@ -71744,9 +73058,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *407 - - *408 - - *535 + - *419 + - *420 + - *547 - *17 - *19 responses: @@ -71756,7 +73070,7 @@ paths: application/json: schema: type: array - items: &706 + items: &718 title: Status description: The status of a commit. type: object @@ -71837,7 +73151,7 @@ paths: site_admin: false headers: Link: *40 - '301': *421 + '301': *433 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71865,8 +73179,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -71895,20 +73209,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *539 - required: *540 + properties: *551 + required: *552 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &541 + properties: &553 url: type: string format: uri html_url: type: string format: uri - required: &542 + required: &554 - url - html_url nullable: true @@ -71916,32 +73230,32 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true contributing: title: Community Health File type: object - properties: *541 - required: *542 + properties: *553 + required: *554 nullable: true readme: title: Community Health File type: object - properties: *541 - required: *542 + properties: *553 + required: *554 nullable: true issue_template: title: Community Health File type: object - properties: *541 - required: *542 + properties: *553 + required: *554 nullable: true pull_request_template: title: Community Health File type: object - properties: *541 - required: *542 + properties: *553 + required: *554 nullable: true required: - code_of_conduct @@ -72068,8 +73382,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *407 - - *408 + - *419 + - *420 - *19 - *17 - name: basehead @@ -72112,8 +73426,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *528 - merge_base_commit: *528 + base_commit: *540 + merge_base_commit: *540 status: type: string enum: @@ -72133,10 +73447,10 @@ paths: example: 6 commits: type: array - items: *528 + items: *540 files: type: array - items: *543 + items: *555 required: - url - html_url @@ -72379,8 +73693,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72422,8 +73736,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *407 - - *408 + - *419 + - *420 - name: path description: path parameter in: path @@ -72566,7 +73880,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &544 + response-if-content-is-a-file: &556 summary: Response if content is a file value: type: file @@ -72698,7 +74012,7 @@ paths: - size - type - url - - &658 + - &670 title: Content File description: Content File type: object @@ -72899,7 +74213,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *544 + response-if-content-is-a-file: *556 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -72968,7 +74282,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *545 + '302': *557 '304': *37 x-github: githubCloudOnly: false @@ -72991,8 +74305,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *407 - - *408 + - *419 + - *420 - name: path description: path parameter in: path @@ -73085,7 +74399,7 @@ paths: description: Response content: application/json: - schema: &546 + schema: &558 title: File Commit description: File Commit type: object @@ -73237,7 +74551,7 @@ paths: description: Response content: application/json: - schema: *546 + schema: *558 examples: example-for-creating-a-file: value: @@ -73291,7 +74605,7 @@ paths: schema: oneOf: - *3 - - &584 + - &596 description: Repository rule violation was detected type: object properties: @@ -73312,7 +74626,7 @@ paths: items: type: object properties: - placeholder_id: &698 + placeholder_id: &710 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -73344,8 +74658,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *407 - - *408 + - *419 + - *420 - name: path description: path parameter in: path @@ -73406,7 +74720,7 @@ paths: description: Response content: application/json: - schema: *546 + schema: *558 examples: default: value: @@ -73440,8 +74754,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *99 - '503': *157 + '409': *101 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73461,8 +74775,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *407 - - *408 + - *419 + - *420 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -73585,23 +74899,23 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *407 - - *408 - - *276 - - *277 - - *278 - - *279 + - *419 + - *420 + - *286 + - *287 + - *288 + - *289 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *280 - - *281 - - *282 - - *283 - - *91 + - *290 + - *291 + - *292 + - *293 + - *93 - name: page description: "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead." @@ -73618,10 +74932,10 @@ paths: schema: type: integer default: 30 - - *89 - - *90 - - *284 - - *285 + - *91 + - *92 + - *294 + - *295 responses: '200': description: Response @@ -73629,11 +74943,11 @@ paths: application/json: schema: type: array - items: &549 + items: &561 type: object description: A Dependabot alert. properties: - number: *103 + number: *105 state: type: string description: The state of the Dependabot alert. @@ -73648,7 +74962,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *104 + package: *106 manifest_path: type: string description: The full path to the dependency manifest file, @@ -73675,13 +74989,13 @@ paths: - unknown - direct - transitive - security_advisory: *547 - security_vulnerability: *107 - url: *108 - html_url: *109 - created_at: *110 - updated_at: *111 - dismissed_at: *112 + security_advisory: *559 + security_vulnerability: *109 + url: *110 + html_url: *111 + created_at: *112 + updated_at: *113 + dismissed_at: *114 dismissed_by: title: Simple User description: A GitHub user. @@ -73705,8 +75019,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *113 - auto_dismissed_at: *548 + fixed_at: *115 + auto_dismissed_at: *560 required: - number - state @@ -73936,9 +75250,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *407 - - *408 - - &550 + - *419 + - *420 + - &562 name: alert_number in: path description: |- @@ -73947,13 +75261,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *103 + schema: *105 responses: '200': description: Response content: application/json: - schema: *549 + schema: *561 examples: default: value: @@ -74066,9 +75380,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *407 - - *408 - - *550 + - *419 + - *420 + - *562 requestBody: required: true content: @@ -74113,7 +75427,7 @@ paths: description: Response content: application/json: - schema: *549 + schema: *561 examples: default: value: @@ -74219,7 +75533,7 @@ paths: '400': *14 '403': *29 '404': *6 - '409': *99 + '409': *101 '422': *7 x-github: githubCloudOnly: false @@ -74242,8 +75556,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -74261,7 +75575,7 @@ paths: type: integer secrets: type: array - items: &553 + items: &565 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -74314,16 +75628,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *551 + schema: *563 examples: - default: *552 + default: *564 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74343,15 +75657,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '200': description: Response content: application/json: - schema: *553 + schema: *565 examples: default: value: @@ -74377,9 +75691,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 requestBody: required: true content: @@ -74407,7 +75721,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -74431,9 +75745,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *407 - - *408 - - *234 + - *419 + - *420 + - *244 responses: '204': description: Response @@ -74455,8 +75769,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *407 - - *408 + - *419 + - *420 - name: basehead description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their @@ -74616,8 +75930,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -74856,8 +76170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -74932,7 +76246,7 @@ paths: - version - url additionalProperties: false - metadata: &554 + metadata: &566 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -74965,7 +76279,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *554 + metadata: *566 resolved: type: object description: A collection of resolved package dependencies. @@ -74978,7 +76292,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *554 + metadata: *566 relationship: type: string description: A notation of whether a dependency is requested @@ -75107,8 +76421,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *407 - - *408 + - *419 + - *420 - name: sha description: The SHA recorded at creation time. in: query @@ -75148,9 +76462,9 @@ paths: application/json: schema: type: array - items: *555 + items: *567 examples: - default: *556 + default: *568 headers: Link: *40 x-github: @@ -75216,8 +76530,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -75298,7 +76612,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *567 examples: simple-example: summary: Simple example @@ -75371,9 +76685,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *407 - - *408 - - &557 + - *419 + - *420 + - &569 name: deployment_id description: deployment_id parameter in: path @@ -75385,7 +76699,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *567 examples: default: value: @@ -75450,9 +76764,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *407 - - *408 - - *557 + - *419 + - *420 + - *569 responses: '204': description: Response @@ -75474,9 +76788,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *407 - - *408 - - *557 + - *419 + - *420 + - *569 - *17 - *19 responses: @@ -75486,7 +76800,7 @@ paths: application/json: schema: type: array - items: &558 + items: &570 title: Deployment Status description: The status of a deployment. type: object @@ -75577,8 +76891,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 required: - id - node_id @@ -75647,9 +76961,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *407 - - *408 - - *557 + - *419 + - *420 + - *569 requestBody: required: true content: @@ -75724,9 +77038,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *570 examples: - default: &559 + default: &571 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -75782,9 +77096,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *407 - - *408 - - *557 + - *419 + - *420 + - *569 - name: status_id in: path required: true @@ -75795,9 +77109,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *570 examples: - default: *559 + default: *571 '404': *6 x-github: githubCloudOnly: false @@ -75824,12 +77138,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 - - *560 - - *561 - - *562 - - *563 + - *419 + - *420 + - *572 + - *573 + - *574 + - *575 - *17 - *19 responses: @@ -75839,12 +77153,12 @@ paths: application/json: schema: type: array - items: *564 + items: *576 examples: - default: *565 + default: *577 '404': *6 '403': *29 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}": get: summary: Get a dismissal request for a code scanning alert for a repository @@ -75865,8 +77179,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: alert_number in: path required: true @@ -75878,7 +77192,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *564 + schema: *576 examples: default: value: @@ -75914,7 +77228,7 @@ paths: html_url: https://github.com/octo-org/smile/code-scanning/alerts/1 '404': *6 '403': *29 - '500': *88 + '500': *90 patch: summary: Review a dismissal request for a code scanning alert for a repository description: |- @@ -75934,8 +77248,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: alert_number in: path required: true @@ -75973,7 +77287,7 @@ paths: '404': *6 '403': *29 '422': *15 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/dismissal-requests/secret-scanning": get: summary: List alert dismissal requests for secret scanning for a repository @@ -75994,12 +77308,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 - - *247 - - *248 - - *249 - - *566 + - *419 + - *420 + - *257 + - *258 + - *259 + - *578 - *17 - *19 responses: @@ -76009,12 +77323,12 @@ paths: application/json: schema: type: array - items: *567 + items: *579 examples: - default: *568 + default: *580 '404': *6 '403': *29 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/dismissal-requests/secret-scanning/{alert_number}": get: summary: Get an alert dismissal request for secret scanning @@ -76036,8 +77350,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: alert_number in: path required: true @@ -76049,7 +77363,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *567 + schema: *579 examples: default: value: @@ -76086,7 +77400,7 @@ paths: html_url: https://github.com/octo-org/smile/security/secret-scanning/17 '404': *6 '403': *29 - '500': *88 + '500': *90 patch: summary: Review an alert dismissal request for secret scanning description: |- @@ -76107,8 +77421,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: alert_number in: path required: true @@ -76158,7 +77472,7 @@ paths: '404': *6 '403': *29 '422': *15 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/dispatches": post: summary: Create a repository dispatch event @@ -76177,8 +77491,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -76235,8 +77549,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -76253,7 +77567,7 @@ paths: type: integer environments: type: array - items: &570 + items: &582 title: Environment description: Details of a deployment environment type: object @@ -76305,7 +77619,7 @@ paths: type: type: string example: wait_timer - wait_timer: &572 + wait_timer: &584 type: integer example: 30 description: The amount of time to delay a job after @@ -76342,11 +77656,11 @@ paths: items: type: object properties: - type: *569 + type: *581 reviewer: anyOf: - *4 - - *255 + - *265 required: - id - node_id @@ -76366,7 +77680,7 @@ paths: - id - node_id - type - deployment_branch_policy: &573 + deployment_branch_policy: &585 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -76482,9 +77796,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *407 - - *408 - - &571 + - *419 + - *420 + - &583 name: environment_name in: path required: true @@ -76497,9 +77811,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *582 examples: - default: &574 + default: &586 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -76583,9 +77897,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 requestBody: required: false content: @@ -76594,7 +77908,7 @@ paths: type: object nullable: true properties: - wait_timer: *572 + wait_timer: *584 prevent_self_review: type: boolean example: false @@ -76611,13 +77925,13 @@ paths: items: type: object properties: - type: *569 + type: *581 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *573 + deployment_branch_policy: *585 additionalProperties: false examples: default: @@ -76637,9 +77951,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *582 examples: - default: *574 + default: *586 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -76663,9 +77977,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 responses: '204': description: Default response @@ -76690,9 +78004,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 - *17 - *19 responses: @@ -76710,7 +78024,7 @@ paths: example: 2 branch_policies: type: array - items: &575 + items: &587 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -76767,9 +78081,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 requestBody: required: true content: @@ -76815,9 +78129,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *587 examples: - example-wildcard: &576 + example-wildcard: &588 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -76859,10 +78173,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *407 - - *408 - - *571 - - &577 + - *419 + - *420 + - *583 + - &589 name: branch_policy_id in: path required: true @@ -76874,9 +78188,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *587 examples: - default: *576 + default: *588 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76895,10 +78209,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *407 - - *408 - - *571 - - *577 + - *419 + - *420 + - *583 + - *589 requestBody: required: true content: @@ -76926,9 +78240,9 @@ paths: description: Response content: application/json: - schema: *575 + schema: *587 examples: - default: *576 + default: *588 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76947,10 +78261,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *407 - - *408 - - *571 - - *577 + - *419 + - *420 + - *583 + - *589 responses: '204': description: Response @@ -76975,9 +78289,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *571 - - *408 - - *407 + - *583 + - *420 + - *419 responses: '200': description: List of deployment protection rules @@ -76993,7 +78307,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &578 + items: &590 title: Deployment protection rule description: Deployment protection rule type: object @@ -77012,7 +78326,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &579 + app: &591 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -77111,9 +78425,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *571 - - *408 - - *407 + - *583 + - *420 + - *419 requestBody: content: application/json: @@ -77134,9 +78448,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *578 + schema: *590 examples: - default: &580 + default: &592 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -77171,9 +78485,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *571 - - *408 - - *407 + - *583 + - *420 + - *419 - *19 - *17 responses: @@ -77192,7 +78506,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *579 + items: *591 examples: default: value: @@ -77227,10 +78541,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *407 - - *408 - - *571 - - &581 + - *419 + - *420 + - *583 + - &593 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -77242,9 +78556,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *590 examples: - default: *580 + default: *592 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77265,10 +78579,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *571 - - *408 - - *407 - - *581 + - *583 + - *420 + - *419 + - *593 responses: '204': description: Response @@ -77294,9 +78608,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 - *17 - *19 responses: @@ -77314,9 +78628,9 @@ paths: type: integer secrets: type: array - items: *444 + items: *456 examples: - default: *445 + default: *457 headers: Link: *40 x-github: @@ -77341,17 +78655,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 responses: '200': description: Response content: application/json: - schema: *446 + schema: *458 examples: - default: *447 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77373,18 +78687,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *407 - - *408 - - *571 - - *234 + - *419 + - *420 + - *583 + - *244 responses: '200': description: Response content: application/json: - schema: *444 + schema: *456 examples: - default: *582 + default: *594 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77406,10 +78720,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *407 - - *408 - - *571 - - *234 + - *419 + - *420 + - *583 + - *244 requestBody: required: true content: @@ -77440,7 +78754,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -77466,10 +78780,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *407 - - *408 - - *571 - - *234 + - *419 + - *420 + - *583 + - *244 responses: '204': description: Default response @@ -77494,10 +78808,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *407 - - *408 - - *571 - - *431 + - *419 + - *420 + - *583 + - *443 - *19 responses: '200': @@ -77514,9 +78828,9 @@ paths: type: integer variables: type: array - items: *448 + items: *460 examples: - default: *449 + default: *461 headers: Link: *40 x-github: @@ -77539,9 +78853,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *407 - - *408 - - *571 + - *419 + - *420 + - *583 requestBody: required: true content: @@ -77568,7 +78882,7 @@ paths: description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -77593,18 +78907,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *407 - - *408 - - *571 - - *237 + - *419 + - *420 + - *583 + - *247 responses: '200': description: Response content: application/json: - schema: *448 + schema: *460 examples: - default: *583 + default: *595 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77625,10 +78939,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *407 - - *408 - - *237 - - *571 + - *419 + - *420 + - *247 + - *583 requestBody: required: true content: @@ -77670,10 +78984,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *407 - - *408 - - *237 - - *571 + - *419 + - *420 + - *247 + - *583 responses: '204': description: Response @@ -77695,8 +79009,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -77706,7 +79020,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: 200-response: value: @@ -77773,8 +79087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *407 - - *408 + - *419 + - *420 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -77796,7 +79110,7 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: default: value: @@ -77933,8 +79247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -77966,9 +79280,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *432 examples: - default: *422 + default: *434 '400': *14 '422': *15 '403': *29 @@ -77989,8 +79303,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -78041,7 +79355,7 @@ paths: schema: type: string '404': *6 - '409': *99 + '409': *101 '403': *29 '422': description: Validation failed @@ -78049,8 +79363,8 @@ paths: application/json: schema: oneOf: - - *207 - - *584 + - *217 + - *596 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78075,8 +79389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *407 - - *408 + - *419 + - *420 - name: file_sha in: path required: true @@ -78127,7 +79441,7 @@ paths: '404': *6 '422': *15 '403': *29 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78175,8 +79489,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -78285,7 +79599,7 @@ paths: description: Response content: application/json: - schema: &585 + schema: &597 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -78449,7 +79763,7 @@ paths: type: string '422': *15 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78499,15 +79813,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *407 - - *408 - - *529 + - *419 + - *420 + - *541 responses: '200': description: Response content: application/json: - schema: *585 + schema: *597 examples: default: value: @@ -78538,7 +79852,7 @@ paths: payload: verified_at: '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78563,9 +79877,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *407 - - *408 - - &586 + - *419 + - *420 + - &598 name: ref description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -78582,7 +79896,7 @@ paths: application/json: schema: type: array - items: &587 + items: &599 title: Git Reference description: Git references within a repository type: object @@ -78636,7 +79950,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *40 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78657,17 +79971,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *407 - - *408 - - *586 + - *419 + - *420 + - *598 responses: '200': description: Response content: application/json: - schema: *587 + schema: *599 examples: - default: &588 + default: &600 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -78677,7 +79991,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78696,8 +80010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -78726,16 +80040,16 @@ paths: description: Response content: application/json: - schema: *587 + schema: *599 examples: - default: *588 + default: *600 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78754,9 +80068,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *407 - - *408 - - *586 + - *419 + - *420 + - *598 requestBody: required: true content: @@ -78785,11 +80099,11 @@ paths: description: Response content: application/json: - schema: *587 + schema: *599 examples: - default: *588 + default: *600 '422': *15 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78805,16 +80119,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *407 - - *408 - - *586 + - *419 + - *420 + - *598 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78862,8 +80176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -78930,7 +80244,7 @@ paths: description: Response content: application/json: - schema: &590 + schema: &602 title: Git Tag description: Metadata for a Git tag type: object @@ -78981,7 +80295,7 @@ paths: - sha - type - url - verification: *589 + verification: *601 required: - sha - url @@ -78991,7 +80305,7 @@ paths: - tag - message examples: - default: &591 + default: &603 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -79018,7 +80332,7 @@ paths: schema: type: string '422': *15 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79064,8 +80378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *407 - - *408 + - *419 + - *420 - name: tag_sha in: path required: true @@ -79076,11 +80390,11 @@ paths: description: Response content: application/json: - schema: *590 + schema: *602 examples: - default: *591 + default: *603 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79102,8 +80416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -79176,7 +80490,7 @@ paths: description: Response content: application/json: - schema: &592 + schema: &604 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -79249,7 +80563,7 @@ paths: '422': *15 '404': *6 '403': *29 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79272,8 +80586,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *407 - - *408 + - *419 + - *420 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -79296,7 +80610,7 @@ paths: description: Response content: application/json: - schema: *592 + schema: *604 examples: default-response: summary: Default response @@ -79337,7 +80651,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79355,8 +80669,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -79366,7 +80680,7 @@ paths: application/json: schema: type: array - items: &593 + items: &605 title: Webhook description: Webhooks for repositories. type: object @@ -79420,7 +80734,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &840 + last_response: &852 title: Hook Response type: object properties: @@ -79494,8 +80808,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -79547,9 +80861,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *605 examples: - default: &594 + default: &606 value: type: Repository id: 12345678 @@ -79597,17 +80911,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 responses: '200': description: Response content: application/json: - schema: *593 + schema: *605 examples: - default: *594 + default: *606 '404': *6 x-github: githubCloudOnly: false @@ -79627,9 +80941,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 requestBody: required: true content: @@ -79674,9 +80988,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *605 examples: - default: *594 + default: *606 '422': *15 '404': *6 x-github: @@ -79697,9 +81011,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 responses: '204': description: Response @@ -79723,9 +81037,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 responses: '200': description: Response @@ -79752,9 +81066,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 requestBody: required: false content: @@ -79798,11 +81112,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 - *17 - - *294 + - *304 responses: '200': description: Response @@ -79810,9 +81124,9 @@ paths: application/json: schema: type: array - items: *295 + items: *305 examples: - default: *296 + default: *306 '400': *14 '422': *15 x-github: @@ -79831,18 +81145,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 - *16 responses: '200': description: Response content: application/json: - schema: *297 + schema: *307 examples: - default: *298 + default: *308 '400': *14 '422': *15 x-github: @@ -79861,9 +81175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 - *16 responses: '202': *39 @@ -79886,9 +81200,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 responses: '204': description: Response @@ -79913,9 +81227,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *407 - - *408 - - *293 + - *419 + - *420 + - *303 responses: '204': description: Response @@ -79973,14 +81287,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: &595 + schema: &607 title: Import description: A repository import from an external source. type: object @@ -80079,7 +81393,7 @@ paths: - html_url - authors_url examples: - default: &598 + default: &610 value: vcs: subversion use_lfs: true @@ -80095,7 +81409,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &596 + '503': &608 description: Unavailable due to service under maintenance. content: application/json: @@ -80124,8 +81438,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -80173,7 +81487,7 @@ paths: description: Response content: application/json: - schema: *595 + schema: *607 examples: default: value: @@ -80198,7 +81512,7 @@ paths: type: string '422': *15 '404': *6 - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80226,8 +81540,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -80276,7 +81590,7 @@ paths: description: Response content: application/json: - schema: *595 + schema: *607 examples: example-1: summary: Example 1 @@ -80324,7 +81638,7 @@ paths: html_url: https://import.github.com/octocat/socm/import authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80347,12 +81661,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80378,9 +81692,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *407 - - *408 - - &783 + - *419 + - *420 + - &795 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -80394,7 +81708,7 @@ paths: application/json: schema: type: array - items: &597 + items: &609 title: Porter Author description: Porter Author type: object @@ -80448,7 +81762,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80473,8 +81787,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *407 - - *408 + - *419 + - *420 - name: author_id in: path required: true @@ -80504,7 +81818,7 @@ paths: description: Response content: application/json: - schema: *597 + schema: *609 examples: default: value: @@ -80517,7 +81831,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80541,8 +81855,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -80583,7 +81897,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80611,8 +81925,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -80639,11 +81953,11 @@ paths: description: Response content: application/json: - schema: *595 + schema: *607 examples: - default: *598 + default: *610 '422': *15 - '503': *596 + '503': *608 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80666,8 +81980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -80675,8 +81989,8 @@ paths: application/json: schema: *22 examples: - default: *599 - '301': *421 + default: *611 + '301': *433 '404': *6 x-github: githubCloudOnly: false @@ -80696,8 +82010,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -80705,12 +82019,12 @@ paths: application/json: schema: anyOf: - - *311 + - *321 - type: object properties: {} additionalProperties: false examples: - default: &601 + default: &613 value: limit: collaborators_only origin: repository @@ -80735,13 +82049,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: application/json: - schema: *600 + schema: *612 examples: default: summary: Example request body @@ -80753,9 +82067,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *321 examples: - default: *601 + default: *613 '409': description: Response x-github: @@ -80777,8 +82091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -80801,8 +82115,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -80812,9 +82126,9 @@ paths: application/json: schema: type: array - items: *602 + items: *614 examples: - default: &776 + default: &788 value: - id: 1 repository: @@ -80945,9 +82259,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *407 - - *408 - - *315 + - *419 + - *420 + - *325 requestBody: required: false content: @@ -80976,7 +82290,7 @@ paths: description: Response content: application/json: - schema: *602 + schema: *614 examples: default: value: @@ -81107,9 +82421,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *407 - - *408 - - *315 + - *419 + - *420 + - *325 responses: '204': description: Response @@ -81140,8 +82454,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *407 - - *408 + - *419 + - *420 - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone @@ -81189,7 +82503,7 @@ paths: required: false schema: type: string - - *319 + - *329 - name: sort description: What to sort results by. in: query @@ -81201,8 +82515,8 @@ paths: - updated - comments default: created - - *91 - - *170 + - *93 + - *174 - *17 - *19 responses: @@ -81212,9 +82526,9 @@ paths: application/json: schema: type: array - items: *180 + items: *184 examples: - default: &613 + default: &623 value: - id: 1 node_id: MDU6SXNzdWUx @@ -81362,7 +82676,7 @@ paths: state_reason: completed headers: Link: *40 - '301': *421 + '301': *433 '422': *15 '404': *6 x-github: @@ -81391,8 +82705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -81474,9 +82788,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: &608 + default: &620 value: id: 1 node_id: MDU6SXNzdWUx @@ -81630,9 +82944,9 @@ paths: '400': *14 '403': *29 '422': *15 - '503': *157 + '503': *159 '404': *6 - '410': *418 + '410': *430 x-github: triggersNotification: true githubCloudOnly: false @@ -81660,9 +82974,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *407 - - *408 - - *190 + - *419 + - *420 + - *194 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -81672,7 +82986,7 @@ paths: enum: - asc - desc - - *170 + - *174 - *17 - *19 responses: @@ -81682,9 +82996,9 @@ paths: application/json: schema: type: array - items: *603 + items: *615 examples: - default: &610 + default: &622 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -81742,17 +83056,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '200': description: Response content: application/json: - schema: *603 + schema: *615 examples: - default: &604 + default: &616 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -81806,9 +83120,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -81830,9 +83144,9 @@ paths: description: Response content: application/json: - schema: *603 + schema: *615 examples: - default: *604 + default: *616 '422': *15 x-github: githubCloudOnly: false @@ -81850,9 +83164,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '204': description: Response @@ -81872,9 +83186,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -81900,9 +83214,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 '404': *6 @@ -81923,9 +83237,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -81957,16 +83271,16 @@ paths: description: Reaction exists content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Reaction created content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '422': *15 x-github: githubCloudOnly: false @@ -81988,10 +83302,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *407 - - *408 - - *179 - - *399 + - *419 + - *420 + - *183 + - *411 responses: '204': description: Response @@ -82011,8 +83325,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -82022,7 +83336,7 @@ paths: application/json: schema: type: array - items: &607 + items: &619 title: Issue Event description: Issue Event type: object @@ -82065,8 +83379,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *605 - required: *606 + properties: *617 + required: *618 nullable: true label: title: Issue Event Label @@ -82110,7 +83424,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *255 + requested_team: *265 dismissed_review: title: Issue Event Dismissed Review type: object @@ -82175,7 +83489,7 @@ paths: required: - from - to - author_association: *167 + author_association: *171 lock_reason: type: string nullable: true @@ -82188,8 +83502,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 required: - id - node_id @@ -82373,8 +83687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *407 - - *408 + - *419 + - *420 - name: event_id in: path required: true @@ -82385,7 +83699,7 @@ paths: description: Response content: application/json: - schema: *607 + schema: *619 examples: default: value: @@ -82578,7 +83892,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *418 + '410': *430 '403': *29 x-github: githubCloudOnly: false @@ -82612,9 +83926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *407 - - *408 - - &609 + - *419 + - *420 + - &621 name: issue_number description: The number that identifies the issue. in: path @@ -82626,12 +83940,12 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 - '301': *421 + default: *620 + '301': *433 '404': *6 - '410': *418 + '410': *430 '304': *37 x-github: githubCloudOnly: false @@ -82656,9 +83970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: false content: @@ -82762,15 +84076,15 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 '422': *15 - '503': *157 + '503': *159 '403': *29 - '301': *421 + '301': *433 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82788,9 +84102,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: false content: @@ -82816,9 +84130,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82834,9 +84148,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: content: application/json: @@ -82861,9 +84175,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82885,9 +84199,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - name: assignee in: path required: true @@ -82927,10 +84241,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *407 - - *408 - - *609 - - *170 + - *419 + - *420 + - *621 + - *174 - *17 - *19 responses: @@ -82940,13 +84254,13 @@ paths: application/json: schema: type: array - items: *603 + items: *615 examples: - default: *610 + default: *622 headers: Link: *40 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82975,9 +84289,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: true content: @@ -82999,16 +84313,16 @@ paths: description: Response content: application/json: - schema: *603 + schema: *615 examples: - default: *604 + default: *616 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *418 + '410': *430 '422': *15 '404': *6 x-github: @@ -83017,6 +84331,210 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": + get: + summary: List dependencies an issue is blocked by + description: |- + You can use the REST API to list the dependencies an issue is blocked by. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - *419 + - *420 + - *621 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *184 + examples: + default: *623 + headers: + Link: *40 + '301': *433 + '404': *6 + '410': *430 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + post: + summary: Add a dependency an issue is blocked by + description: |- + You can use the REST API to add a 'blocked by' relationship to an issue. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - *419 + - *420 + - *621 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: *184 + examples: + default: *620 + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': *433 + '403': *29 + '410': *430 + '422': *15 + '404': *6 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": + delete: + summary: Remove dependency an issue is blocked by + description: |- + You can use the REST API to remove a dependency that an issue is blocked by. + + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - *419 + - *420 + - *621 + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *184 + examples: + default: *620 + '301': *433 + '400': *14 + '401': *25 + '403': *29 + '404': *6 + '410': *430 + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": + get: + summary: List dependencies an issue is blocking + description: |- + You can use the REST API to list the dependencies an issue is blocking. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - *419 + - *420 + - *621 + - *17 + - *19 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *184 + examples: + default: *623 + headers: + Link: *40 + '301': *433 + '404': *6 + '410': *430 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events @@ -83028,9 +84546,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - *17 - *19 responses: @@ -83044,7 +84562,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &614 + - &626 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -83075,8 +84593,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 label: type: object properties: @@ -83098,7 +84616,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &615 + - &627 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -83129,8 +84647,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 label: type: object properties: @@ -83218,8 +84736,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 assignee: *4 assigner: *4 required: @@ -83234,7 +84752,7 @@ paths: - performed_via_github_app - assignee - assigner - - &616 + - &628 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -83265,8 +84783,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 milestone: type: object properties: @@ -83285,7 +84803,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &617 + - &629 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -83316,8 +84834,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 milestone: type: object properties: @@ -83336,7 +84854,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &618 + - &630 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -83367,8 +84885,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 rename: type: object properties: @@ -83390,7 +84908,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &619 + - &631 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -83421,10 +84939,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 review_requester: *4 - requested_team: *255 + requested_team: *265 requested_reviewer: *4 required: - review_requester @@ -83437,7 +84955,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &620 + - &632 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -83468,10 +84986,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 review_requester: *4 - requested_team: *255 + requested_team: *265 requested_reviewer: *4 required: - review_requester @@ -83484,7 +85002,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &621 + - &633 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -83515,8 +85033,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 dismissed_review: type: object properties: @@ -83544,7 +85062,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &622 + - &634 title: Locked Issue Event description: Locked Issue Event type: object @@ -83575,8 +85093,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 lock_reason: type: string example: '"off-topic"' @@ -83592,7 +85110,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &623 + - &635 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -83623,8 +85141,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 project_card: type: object properties: @@ -83658,7 +85176,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &624 + - &636 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -83689,8 +85207,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 project_card: type: object properties: @@ -83724,7 +85242,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &625 + - &637 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -83755,8 +85273,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 project_card: type: object properties: @@ -83790,7 +85308,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &626 + - &638 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -83881,7 +85399,7 @@ paths: color: red headers: Link: *40 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83898,9 +85416,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - *17 - *19 responses: @@ -83910,7 +85428,7 @@ paths: application/json: schema: type: array - items: &611 + items: &624 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -83957,7 +85475,7 @@ paths: - color - default examples: - default: &612 + default: &625 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -83975,9 +85493,9 @@ paths: default: false headers: Link: *40 - '301': *421 + '301': *433 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83994,9 +85512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: false content: @@ -84055,12 +85573,12 @@ paths: application/json: schema: type: array - items: *611 + items: *624 examples: - default: *612 - '301': *421 + default: *625 + '301': *433 '404': *6 - '410': *418 + '410': *430 '422': *15 x-github: githubCloudOnly: false @@ -84077,9 +85595,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: false content: @@ -84139,12 +85657,12 @@ paths: application/json: schema: type: array - items: *611 + items: *624 examples: - default: *612 - '301': *421 + default: *625 + '301': *433 '404': *6 - '410': *418 + '410': *430 '422': *15 x-github: githubCloudOnly: false @@ -84161,15 +85679,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 responses: '204': description: Response - '301': *421 + '301': *433 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84188,9 +85706,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - name: name in: path required: true @@ -84203,7 +85721,7 @@ paths: application/json: schema: type: array - items: *611 + items: *624 examples: default: value: @@ -84214,9 +85732,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *421 + '301': *433 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84236,9 +85754,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: false content: @@ -84266,7 +85784,7 @@ paths: '204': description: Response '403': *29 - '410': *418 + '410': *430 '404': *6 '422': *15 x-github: @@ -84284,9 +85802,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 responses: '204': description: Response @@ -84308,9 +85826,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. @@ -84336,13 +85854,13 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84360,9 +85878,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: true content: @@ -84394,16 +85912,16 @@ paths: description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '422': *15 x-github: githubCloudOnly: false @@ -84425,10 +85943,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *407 - - *408 - - *609 - - *399 + - *419 + - *420 + - *621 + - *411 responses: '204': description: Response @@ -84457,9 +85975,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: true content: @@ -84481,9 +85999,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -84516,9 +86034,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - *17 - *19 responses: @@ -84528,13 +86046,13 @@ paths: application/json: schema: type: array - items: *180 + items: *184 examples: - default: *613 + default: *623 headers: Link: *40 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84562,9 +86080,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: true content: @@ -84591,16 +86109,16 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *418 + '410': *430 '422': *15 '404': *6 x-github: @@ -84620,9 +86138,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 requestBody: required: true content: @@ -84653,13 +86171,13 @@ paths: description: Response content: application/json: - schema: *180 + schema: *184 examples: - default: *608 + default: *620 '403': *29 '404': *6 '422': *7 - '503': *157 + '503': *159 x-github: triggersNotification: true githubCloudOnly: false @@ -84677,9 +86195,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *407 - - *408 - - *609 + - *419 + - *420 + - *621 - *17 - *19 responses: @@ -84694,19 +86212,19 @@ paths: description: Timeline Event type: object anyOf: - - *614 - - *615 - - *616 - - *617 - - *618 - - *619 - - *620 - - *621 - - *622 - - *623 - - *624 - - *625 - *626 + - *627 + - *628 + - *629 + - *630 + - *631 + - *632 + - *633 + - *634 + - *635 + - *636 + - *637 + - *638 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -84749,7 +86267,7 @@ paths: issue_url: type: string format: uri - author_association: *167 + author_association: *171 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -84759,9 +86277,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 - reactions: *168 + properties: *169 + required: *170 + reactions: *172 required: - event - actor @@ -84792,7 +86310,7 @@ paths: properties: type: type: string - issue: *180 + issue: *184 required: - event - created_at @@ -84988,7 +86506,7 @@ paths: type: string body_text: type: string - author_association: *167 + author_association: *171 required: - event - id @@ -85011,7 +86529,7 @@ paths: type: string comments: type: array - items: &647 + items: &659 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -85100,7 +86618,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *167 + author_association: *171 _links: type: object properties: @@ -85184,7 +86702,7 @@ paths: enum: - line - file - reactions: *168 + reactions: *172 body_html: type: string example: '"

comment body

"' @@ -85220,7 +86738,7 @@ paths: type: string comments: type: array - items: *527 + items: *539 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -85251,8 +86769,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 assignee: *4 required: - id @@ -85295,8 +86813,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 assignee: *4 required: - id @@ -85339,8 +86857,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 state_reason: type: string nullable: true @@ -85509,7 +87027,7 @@ paths: headers: Link: *40 '404': *6 - '410': *418 + '410': *430 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85526,8 +87044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -85537,7 +87055,7 @@ paths: application/json: schema: type: array - items: &627 + items: &639 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -85603,8 +87121,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -85640,9 +87158,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *639 examples: - default: &628 + default: &640 value: id: 1 key: ssh-rsa AAA... @@ -85676,9 +87194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *407 - - *408 - - &629 + - *419 + - *420 + - &641 name: key_id description: The unique identifier of the key. in: path @@ -85690,9 +87208,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *639 examples: - default: *628 + default: *640 '404': *6 x-github: githubCloudOnly: false @@ -85710,9 +87228,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *407 - - *408 - - *629 + - *419 + - *420 + - *641 responses: '204': description: Response @@ -85732,8 +87250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -85743,9 +87261,9 @@ paths: application/json: schema: type: array - items: *611 + items: *624 examples: - default: *612 + default: *625 headers: Link: *40 '404': *6 @@ -85766,8 +87284,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -85803,9 +87321,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *624 examples: - default: &630 + default: &642 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -85837,8 +87355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *407 - - *408 + - *419 + - *420 - name: name in: path required: true @@ -85849,9 +87367,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *624 examples: - default: *630 + default: *642 '404': *6 x-github: githubCloudOnly: false @@ -85868,8 +87386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *407 - - *408 + - *419 + - *420 - name: name in: path required: true @@ -85908,7 +87426,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *624 examples: default: value: @@ -85934,8 +87452,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *407 - - *408 + - *419 + - *420 - name: name in: path required: true @@ -85961,8 +87479,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -85998,8 +87516,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '202': *39 '403': @@ -86027,8 +87545,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -86054,9 +87572,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *407 - - *408 - - *503 + - *419 + - *420 + - *515 responses: '200': description: Response @@ -86118,8 +87636,8 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true required: - _links @@ -86201,8 +87719,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -86267,8 +87785,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -86302,9 +87820,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *528 + schema: *540 examples: - default: *631 + default: *643 '204': description: Response when already merged '404': @@ -86329,8 +87847,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *407 - - *408 + - *419 + - *420 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -86371,12 +87889,12 @@ paths: application/json: schema: type: array - items: &632 + items: &644 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *532 - required: *533 + properties: *544 + required: *545 examples: default: value: @@ -86432,8 +87950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -86473,9 +87991,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *644 examples: - default: &633 + default: &645 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -86534,9 +88052,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *407 - - *408 - - &634 + - *419 + - *420 + - &646 name: milestone_number description: The number that identifies the milestone. in: path @@ -86548,9 +88066,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *644 examples: - default: *633 + default: *645 '404': *6 x-github: githubCloudOnly: false @@ -86567,9 +88085,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *407 - - *408 - - *634 + - *419 + - *420 + - *646 requestBody: required: false content: @@ -86607,9 +88125,9 @@ paths: description: Response content: application/json: - schema: *632 + schema: *644 examples: - default: *633 + default: *645 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86625,9 +88143,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *407 - - *408 - - *634 + - *419 + - *420 + - *646 responses: '204': description: Response @@ -86648,9 +88166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *407 - - *408 - - *634 + - *419 + - *420 + - *646 - *17 - *19 responses: @@ -86660,9 +88178,9 @@ paths: application/json: schema: type: array - items: *611 + items: *624 examples: - default: *612 + default: *625 headers: Link: *40 x-github: @@ -86681,12 +88199,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *407 - - *408 - - *635 - - *636 - - *170 - - *637 + - *419 + - *420 + - *647 + - *648 + - *174 + - *649 - *17 - *19 responses: @@ -86696,9 +88214,9 @@ paths: application/json: schema: type: array - items: *193 + items: *197 examples: - default: *638 + default: *650 headers: Link: *40 x-github: @@ -86722,8 +88240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -86781,14 +88299,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: &639 + schema: &651 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -86913,7 +88431,7 @@ paths: - custom_404 - public examples: - default: &640 + default: &652 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -86954,8 +88472,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -87009,11 +88527,11 @@ paths: description: Response content: application/json: - schema: *639 + schema: *651 examples: - default: *640 + default: *652 '422': *15 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87034,8 +88552,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -87121,7 +88639,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87142,14 +88660,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response '422': *15 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87169,8 +88687,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -87180,7 +88698,7 @@ paths: application/json: schema: type: array - items: &641 + items: &653 title: Page Build description: Page Build type: object @@ -87274,8 +88792,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *407 - - *408 + - *419 + - *420 responses: '201': description: Response @@ -87320,16 +88838,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *641 + schema: *653 examples: - default: &642 + default: &654 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -87377,8 +88895,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *407 - - *408 + - *419 + - *420 - name: build_id in: path required: true @@ -87389,9 +88907,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *653 examples: - default: *642 + default: *654 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87411,8 +88929,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -87517,9 +89035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *407 - - *408 - - &643 + - *419 + - *420 + - &655 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -87577,11 +89095,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *407 - - *408 - - *643 + - *419 + - *420 + - *655 responses: - '204': *123 + '204': *125 '404': *6 x-github: githubCloudOnly: false @@ -87606,8 +89124,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -87838,7 +89356,7 @@ paths: description: Empty response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -87865,8 +89383,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Private vulnerability reporting status @@ -87903,10 +89421,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: - '204': *123 + '204': *125 '422': *14 x-github: githubCloudOnly: false @@ -87925,10 +89443,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: - '204': *123 + '204': *125 '422': *14 x-github: githubCloudOnly: false @@ -87949,8 +89467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-repository-projects parameters: - - *407 - - *408 + - *419 + - *420 - name: state description: Indicates the state of the projects to return. in: query @@ -87971,7 +89489,7 @@ paths: application/json: schema: type: array - items: *350 + items: *360 examples: default: value: @@ -88011,7 +89529,7 @@ paths: '401': *25 '403': *29 '404': *6 - '410': *418 + '410': *430 '422': *7 x-github: githubCloudOnly: false @@ -88034,8 +89552,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#create-a-repository-project parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -88061,13 +89579,13 @@ paths: description: Response content: application/json: - schema: *350 + schema: *360 examples: - default: *417 + default: *429 '401': *25 '403': *29 '404': *6 - '410': *418 + '410': *430 '422': *7 x-github: githubCloudOnly: false @@ -88090,8 +89608,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -88099,7 +89617,7 @@ paths: application/json: schema: type: array - items: *352 + items: *362 examples: default: value: @@ -88130,8 +89648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -88143,7 +89661,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *352 + items: *362 required: - properties examples: @@ -88193,8 +89711,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *407 - - *408 + - *419 + - *420 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -88254,9 +89772,9 @@ paths: application/json: schema: type: array - items: *644 + items: *656 examples: - default: *645 + default: *657 headers: Link: *40 '304': *37 @@ -88288,8 +89806,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -88354,7 +89872,7 @@ paths: description: Response content: application/json: - schema: &649 + schema: &661 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -88465,8 +89983,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *532 - required: *533 + properties: *544 + required: *545 nullable: true active_lock_reason: type: string @@ -88511,7 +90029,7 @@ paths: nullable: true requested_teams: type: array - items: *374 + items: *386 nullable: true head: type: object @@ -88520,7 +90038,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *66 sha: type: string user: *4 @@ -88537,7 +90055,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *66 sha: type: string user: *4 @@ -88550,14 +90068,14 @@ paths: _links: type: object properties: - comments: *534 - commits: *534 - statuses: *534 - html: *534 - issue: *534 - review_comments: *534 - review_comment: *534 - self: *534 + comments: *546 + commits: *546 + statuses: *546 + html: *546 + issue: *546 + review_comments: *546 + review_comment: *546 + self: *546 required: - comments - commits @@ -88567,8 +90085,8 @@ paths: - review_comments - review_comment - self - author_association: *167 - auto_merge: *646 + author_association: *171 + auto_merge: *658 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -88660,7 +90178,7 @@ paths: - merged_by - review_comments examples: - default: &650 + default: &662 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -89187,8 +90705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: sort in: query required: false @@ -89207,7 +90725,7 @@ paths: enum: - asc - desc - - *170 + - *174 - *17 - *19 responses: @@ -89217,9 +90735,9 @@ paths: application/json: schema: type: array - items: *647 + items: *659 examples: - default: &652 + default: &664 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89296,17 +90814,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '200': description: Response content: application/json: - schema: *647 + schema: *659 examples: - default: &648 + default: &660 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -89381,9 +90899,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -89405,9 +90923,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *659 examples: - default: *648 + default: *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89423,9 +90941,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 responses: '204': description: Response @@ -89446,9 +90964,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -89474,9 +90992,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 '404': *6 @@ -89497,9 +91015,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *407 - - *408 - - *179 + - *419 + - *420 + - *183 requestBody: required: true content: @@ -89531,16 +91049,16 @@ paths: description: Reaction exists content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Reaction created content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '422': *15 x-github: githubCloudOnly: false @@ -89562,10 +91080,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *407 - - *408 - - *179 - - *399 + - *419 + - *420 + - *183 + - *411 responses: '204': description: Response @@ -89608,9 +91126,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *407 - - *408 - - &651 + - *419 + - *420 + - &663 name: pull_number description: The number that identifies the pull request. in: path @@ -89623,9 +91141,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *649 + schema: *661 examples: - default: *650 + default: *662 '304': *37 '404': *6 '406': @@ -89633,8 +91151,8 @@ paths: content: application/json: schema: *3 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89660,9 +91178,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: false content: @@ -89704,9 +91222,9 @@ paths: description: Response content: application/json: - schema: *649 + schema: *661 examples: - default: *650 + default: *662 '422': *15 '403': *29 x-github: @@ -89728,9 +91246,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: true content: @@ -89790,21 +91308,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '401': *25 '403': *29 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -89830,10 +91348,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *407 - - *408 - - *651 - - *190 + - *419 + - *420 + - *663 + - *194 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -89843,7 +91361,7 @@ paths: enum: - asc - desc - - *170 + - *174 - *17 - *19 responses: @@ -89853,9 +91371,9 @@ paths: application/json: schema: type: array - items: *647 + items: *659 examples: - default: *652 + default: *664 headers: Link: *40 x-github: @@ -89888,9 +91406,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: true content: @@ -89995,7 +91513,7 @@ paths: description: Response content: application/json: - schema: *647 + schema: *659 examples: example-for-a-multi-line-comment: value: @@ -90083,10 +91601,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *407 - - *408 - - *651 - - *179 + - *419 + - *420 + - *663 + - *183 requestBody: required: true content: @@ -90108,7 +91626,7 @@ paths: description: Response content: application/json: - schema: *647 + schema: *659 examples: default: value: @@ -90194,9 +91712,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 - *17 - *19 responses: @@ -90206,9 +91724,9 @@ paths: application/json: schema: type: array - items: *528 + items: *540 examples: - default: *653 + default: *665 headers: Link: *40 x-github: @@ -90238,9 +91756,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 - *17 - *19 responses: @@ -90250,7 +91768,7 @@ paths: application/json: schema: type: array - items: *543 + items: *555 examples: default: value: @@ -90268,8 +91786,8 @@ paths: headers: Link: *40 '422': *15 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90288,9 +91806,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 responses: '204': description: Response if pull request has been merged @@ -90313,9 +91831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: false content: @@ -90426,9 +91944,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 responses: '200': description: Response @@ -90444,7 +91962,7 @@ paths: items: *4 teams: type: array - items: *255 + items: *265 required: - users - teams @@ -90503,9 +92021,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: false content: @@ -90542,7 +92060,7 @@ paths: description: Response content: application/json: - schema: *644 + schema: *656 examples: default: value: @@ -91078,9 +92596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: true content: @@ -91114,7 +92632,7 @@ paths: description: Response content: application/json: - schema: *644 + schema: *656 examples: default: value: @@ -91619,9 +93137,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 - *17 - *19 responses: @@ -91631,7 +93149,7 @@ paths: application/json: schema: type: array - items: &654 + items: &666 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -91700,7 +93218,7 @@ paths: type: string body_text: type: string - author_association: *167 + author_association: *171 required: - id - node_id @@ -91782,9 +93300,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: false content: @@ -91870,9 +93388,9 @@ paths: description: Response content: application/json: - schema: *654 + schema: *666 examples: - default: &656 + default: &668 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -91935,10 +93453,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 - - &655 + - *419 + - *420 + - *663 + - &667 name: review_id description: The unique identifier of the review. in: path @@ -91950,9 +93468,9 @@ paths: description: Response content: application/json: - schema: *654 + schema: *666 examples: - default: &657 + default: &669 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -92011,10 +93529,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 - - *655 + - *419 + - *420 + - *663 + - *667 requestBody: required: true content: @@ -92037,7 +93555,7 @@ paths: description: Response content: application/json: - schema: *654 + schema: *666 examples: default: value: @@ -92099,18 +93617,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 - - *655 + - *419 + - *420 + - *663 + - *667 responses: '200': description: Response content: application/json: - schema: *654 + schema: *666 examples: - default: *656 + default: *668 '422': *7 '404': *6 x-github: @@ -92137,10 +93655,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *407 - - *408 - - *651 - - *655 + - *419 + - *420 + - *663 + - *667 - *17 - *19 responses: @@ -92219,13 +93737,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *167 + author_association: *171 _links: type: object properties: - self: *534 - html: *534 - pull_request: *534 + self: *546 + html: *546 + pull_request: *546 required: - self - html @@ -92234,7 +93752,7 @@ paths: type: string body_html: type: string - reactions: *168 + reactions: *172 side: description: The side of the first line of the range for a multi-line comment. @@ -92375,10 +93893,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 - - *655 + - *419 + - *420 + - *663 + - *667 requestBody: required: true content: @@ -92406,7 +93924,7 @@ paths: description: Response content: application/json: - schema: *654 + schema: *666 examples: default: value: @@ -92469,10 +93987,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *407 - - *408 - - *651 - - *655 + - *419 + - *420 + - *663 + - *667 requestBody: required: true content: @@ -92507,9 +94025,9 @@ paths: description: Response content: application/json: - schema: *654 + schema: *666 examples: - default: *657 + default: *669 '404': *6 '422': *7 '403': *29 @@ -92531,9 +94049,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *407 - - *408 - - *651 + - *419 + - *420 + - *663 requestBody: required: false content: @@ -92596,8 +94114,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *407 - - *408 + - *419 + - *420 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -92610,9 +94128,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *670 examples: - default: &659 + default: &671 value: type: file encoding: base64 @@ -92654,8 +94172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *407 - - *408 + - *419 + - *420 - name: dir description: The alternate path to look for a README file in: path @@ -92675,9 +94193,9 @@ paths: description: Response content: application/json: - schema: *658 + schema: *670 examples: - default: *659 + default: *671 '404': *6 '422': *15 x-github: @@ -92699,8 +94217,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -92710,7 +94228,7 @@ paths: application/json: schema: type: array - items: &660 + items: &672 title: Release description: A release. type: object @@ -92777,7 +94295,7 @@ paths: author: *4 assets: type: array - items: &661 + items: &673 title: Release Asset description: Data related to a release. type: object @@ -92852,7 +94370,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *168 + reactions: *172 required: - assets_url - upload_url @@ -92964,8 +94482,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -93041,9 +94559,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *672 examples: - default: &664 + default: &676 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -93148,9 +94666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *407 - - *408 - - &662 + - *419 + - *420 + - &674 name: asset_id description: The unique identifier of the asset. in: path @@ -93162,9 +94680,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *673 examples: - default: &663 + default: &675 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -93199,7 +94717,7 @@ paths: type: User site_admin: false '404': *6 - '302': *545 + '302': *557 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93215,9 +94733,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *407 - - *408 - - *662 + - *419 + - *420 + - *674 requestBody: required: false content: @@ -93245,9 +94763,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *673 examples: - default: *663 + default: *675 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93263,9 +94781,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *407 - - *408 - - *662 + - *419 + - *420 + - *674 responses: '204': description: Response @@ -93289,8 +94807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -93375,16 +94893,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response content: application/json: - schema: *660 + schema: *672 examples: - default: *664 + default: *676 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93401,8 +94919,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *407 - - *408 + - *419 + - *420 - name: tag description: tag parameter in: path @@ -93415,9 +94933,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *672 examples: - default: *664 + default: *676 '404': *6 x-github: githubCloudOnly: false @@ -93439,9 +94957,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *407 - - *408 - - &665 + - *419 + - *420 + - &677 name: release_id description: The unique identifier of the release. in: path @@ -93455,9 +94973,9 @@ paths: For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: - schema: *660 + schema: *672 examples: - default: *664 + default: *676 '401': description: Unauthorized x-github: @@ -93475,9 +94993,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 requestBody: required: false content: @@ -93541,9 +95059,9 @@ paths: description: Response content: application/json: - schema: *660 + schema: *672 examples: - default: *664 + default: *676 '404': description: Not Found if the discussion category name is invalid content: @@ -93564,9 +95082,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 responses: '204': description: Response @@ -93586,9 +95104,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 - *17 - *19 responses: @@ -93598,7 +95116,7 @@ paths: application/json: schema: type: array - items: *661 + items: *673 examples: default: value: @@ -93680,9 +95198,9 @@ paths: description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 - name: name in: query required: true @@ -93708,7 +95226,7 @@ paths: description: Response for successful upload content: application/json: - schema: *661 + schema: *673 examples: response-for-successful-upload: value: @@ -93763,9 +95281,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -93789,9 +95307,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 '404': *6 @@ -93812,9 +95330,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *407 - - *408 - - *665 + - *419 + - *420 + - *677 requestBody: required: true content: @@ -93844,16 +95362,16 @@ paths: description: Reaction exists content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '201': description: Reaction created content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 '422': *15 x-github: githubCloudOnly: false @@ -93875,10 +95393,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *407 - - *408 - - *665 - - *399 + - *419 + - *420 + - *677 + - *411 responses: '204': description: Response @@ -93902,9 +95420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *407 - - *408 - - *466 + - *419 + - *420 + - *478 - *17 - *19 responses: @@ -93920,8 +95438,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *132 - - &666 + - *134 + - &678 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -93940,66 +95458,66 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *133 - - *666 - - allOf: - - *134 - - *666 - allOf: - *135 - - *666 - - allOf: - - *667 - - *666 + - *678 - allOf: - *136 - - *666 + - *678 - allOf: - *137 - - *666 + - *678 + - allOf: + - *679 + - *678 - allOf: - *138 - - *666 + - *678 - allOf: - *139 - - *666 + - *678 - allOf: - *140 - - *666 + - *678 - allOf: - *141 - - *666 + - *678 - allOf: - *142 - - *666 + - *678 - allOf: - *143 - - *666 + - *678 - allOf: - *144 - - *666 + - *678 - allOf: - *145 - - *666 + - *678 - allOf: - *146 - - *666 + - *678 - allOf: - *147 - - *666 + - *678 - allOf: - *148 - - *666 + - *678 - allOf: - *149 - - *666 + - *678 - allOf: - *150 - - *666 + - *678 - allOf: - *151 - - *666 + - *678 + - allOf: + - *152 + - *678 + - allOf: + - *153 + - *678 examples: default: value: @@ -94038,8 +95556,8 @@ paths: category: repos subcategory: rules parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 - name: includes_parents @@ -94050,7 +95568,7 @@ paths: schema: type: boolean default: true - - *668 + - *680 responses: '200': description: Response @@ -94058,7 +95576,7 @@ paths: application/json: schema: type: array - items: *152 + items: *154 examples: default: value: @@ -94089,7 +95607,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -94105,8 +95623,8 @@ paths: category: repos subcategory: rules parameters: - - *407 - - *408 + - *419 + - *420 requestBody: description: Request body required: true @@ -94126,16 +95644,16 @@ paths: - tag - push default: branch - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 - conditions: *126 + items: *133 + conditions: *128 rules: type: array description: An array of rules within the ruleset. - items: *669 + items: *681 required: - name - enforcement @@ -94166,9 +95684,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: &678 + default: &690 value: id: 42 name: super cool ruleset @@ -94201,7 +95719,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -94215,12 +95733,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *407 - - *408 - - *670 - - *249 - - *671 - - *672 + - *419 + - *420 + - *682 + - *259 + - *683 + - *684 - *17 - *19 responses: @@ -94228,11 +95746,11 @@ paths: description: Response content: application/json: - schema: *673 + schema: *685 examples: - default: *674 + default: *686 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94251,19 +95769,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *407 - - *408 - - *675 + - *419 + - *420 + - *687 responses: '200': description: Response content: application/json: - schema: *676 + schema: *688 examples: - default: *677 + default: *689 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94289,8 +95807,8 @@ paths: category: repos subcategory: rules parameters: - - *407 - - *408 + - *419 + - *420 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94310,11 +95828,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *678 + default: *690 '404': *6 - '500': *88 + '500': *90 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -94330,8 +95848,8 @@ paths: category: repos subcategory: rules parameters: - - *407 - - *408 + - *419 + - *420 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94356,16 +95874,16 @@ paths: - branch - tag - push - enforcement: *130 + enforcement: *132 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *131 - conditions: *126 + items: *133 + conditions: *128 rules: description: An array of rules within the ruleset. type: array - items: *669 + items: *681 examples: default: value: @@ -94393,11 +95911,11 @@ paths: description: Response content: application/json: - schema: *152 + schema: *154 examples: - default: *678 + default: *690 '404': *6 - '500': *88 + '500': *90 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -94413,8 +95931,8 @@ paths: category: repos subcategory: rules parameters: - - *407 - - *408 + - *419 + - *420 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94425,7 +95943,7 @@ paths: '204': description: Response '404': *6 - '500': *88 + '500': *90 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -94437,8 +95955,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 - name: ruleset_id @@ -94454,11 +95972,11 @@ paths: application/json: schema: type: array - items: *156 + items: *158 examples: - default: *361 + default: *371 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94475,8 +95993,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *407 - - *408 + - *419 + - *420 - name: ruleset_id description: The ID of the ruleset. in: path @@ -94494,7 +96012,7 @@ paths: description: Response content: application/json: - schema: *362 + schema: *372 examples: default: value: @@ -94527,7 +96045,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94549,21 +96067,21 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *407 - - *408 - - *363 - - *364 - - *365 - - *366 - - *91 + - *419 + - *420 + - *373 + - *374 + - *375 + - *376 + - *93 - *19 - *17 - - *679 - - *680 - - *367 - - *368 - - *369 - - *370 + - *691 + - *692 + - *377 + - *378 + - *379 + - *380 responses: '200': description: Response @@ -94571,11 +96089,11 @@ paths: application/json: schema: type: array - items: &684 + items: &696 type: object properties: - number: *103 - created_at: *110 + number: *105 + created_at: *112 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -94583,15 +96101,15 @@ paths: format: date-time readOnly: true nullable: true - url: *108 - html_url: *109 + url: *110 + html_url: *111 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *681 - resolution: *682 + state: *693 + resolution: *694 resolved_at: type: string format: date-time @@ -94687,7 +96205,7 @@ paths: pull request. ' - oneOf: *683 + oneOf: *695 nullable: true has_more_locations: type: boolean @@ -94815,7 +96333,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94837,16 +96355,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *407 - - *408 - - *497 - - *370 + - *419 + - *420 + - *509 + - *380 responses: '200': description: Response content: application/json: - schema: *684 + schema: *696 examples: default: value: @@ -94877,7 +96395,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94898,9 +96416,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 requestBody: required: true content: @@ -94908,8 +96426,8 @@ paths: schema: type: object properties: - state: *681 - resolution: *682 + state: *693 + resolution: *694 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. @@ -94927,7 +96445,7 @@ paths: description: Response content: application/json: - schema: *684 + schema: *696 examples: default: value: @@ -94980,7 +96498,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -95002,9 +96520,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *407 - - *408 - - *497 + - *419 + - *420 + - *509 - *19 - *17 responses: @@ -95015,7 +96533,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &861 + items: &875 type: object properties: type: @@ -95041,19 +96559,19 @@ paths: example: commit details: oneOf: - - *685 - - *686 - - *687 - - *688 - - *689 - - *690 - - *691 - - *692 - - *693 - - *694 - - *695 - - *696 - *697 + - *698 + - *699 + - *700 + - *701 + - *702 + - *703 + - *704 + - *705 + - *706 + - *707 + - *708 + - *709 examples: default: value: @@ -95117,7 +96635,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95139,8 +96657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -95148,14 +96666,14 @@ paths: schema: type: object properties: - reason: &699 + reason: &711 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *698 + placeholder_id: *710 required: - reason - placeholder_id @@ -95172,7 +96690,7 @@ paths: schema: type: object properties: - reason: *699 + reason: *711 expire_at: type: string format: date-time @@ -95195,7 +96713,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *157 + '503': *159 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -95215,13 +96733,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *157 + '503': *159 '200': description: Response content: @@ -95231,7 +96749,7 @@ paths: properties: incremental_scans: type: array - items: &700 + items: &712 description: Information on a single scan performed by secret scanning on the repository type: object @@ -95257,15 +96775,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *700 + items: *712 backfill_scans: type: array - items: *700 + items: *712 custom_pattern_backfill_scans: type: array items: allOf: - - *700 + - *712 - type: object properties: pattern_name: @@ -95335,9 +96853,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *407 - - *408 - - *91 + - *419 + - *420 + - *93 - name: sort description: The property to sort the results by. in: query @@ -95349,8 +96867,8 @@ paths: - updated - published default: created - - *89 - - *90 + - *91 + - *92 - name: per_page description: The number of advisories to return per page. 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)." @@ -95380,9 +96898,9 @@ paths: application/json: schema: type: array - items: *701 + items: *713 examples: - default: *702 + default: *714 '400': *14 '404': *6 x-github: @@ -95405,8 +96923,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -95479,7 +96997,7 @@ paths: login: type: string description: The username of the user credited. - type: *373 + type: *385 required: - login - type @@ -95566,9 +97084,9 @@ paths: description: Response content: application/json: - schema: *701 + schema: *713 examples: - default: &704 + default: &716 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -95801,8 +97319,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -95906,7 +97424,7 @@ paths: description: Response content: application/json: - schema: *701 + schema: *713 examples: default: value: @@ -96053,17 +97571,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *407 - - *408 - - *703 + - *419 + - *420 + - *715 responses: '200': description: Response content: application/json: - schema: *701 + schema: *713 examples: - default: *704 + default: *716 '403': *29 '404': *6 x-github: @@ -96087,9 +97605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *407 - - *408 - - *703 + - *419 + - *420 + - *715 requestBody: required: true content: @@ -96162,7 +97680,7 @@ paths: login: type: string description: The username of the user credited. - type: *373 + type: *385 required: - login - type @@ -96248,17 +97766,17 @@ paths: description: Response content: application/json: - schema: *701 + schema: *713 examples: - default: *704 - add_credit: *704 + default: *716 + add_credit: *716 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *207 + schema: *217 examples: invalid_state_transition: value: @@ -96289,9 +97807,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *407 - - *408 - - *703 + - *419 + - *420 + - *715 responses: '202': *39 '400': *14 @@ -96318,17 +97836,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *407 - - *408 - - *703 + - *419 + - *420 + - *715 responses: '202': description: Response content: application/json: - schema: *420 + schema: *432 examples: - default: *422 + default: *434 '400': *14 '422': *15 '403': *29 @@ -96354,8 +97872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -96454,8 +97972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -96464,7 +97982,7 @@ paths: application/json: schema: type: array - items: &705 + items: &717 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -96477,7 +97995,7 @@ paths: - 1124 - -435 '202': *39 - '204': *123 + '204': *125 '422': description: Repository contains more than 10,000 commits x-github: @@ -96497,8 +98015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -96547,7 +98065,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *123 + '204': *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96574,8 +98092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -96649,7 +98167,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *123 + '204': *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96671,8 +98189,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -96826,8 +98344,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -96837,7 +98355,7 @@ paths: application/json: schema: type: array - items: *705 + items: *717 examples: default: value: @@ -96850,7 +98368,7 @@ paths: - - 0 - 2 - 21 - '204': *123 + '204': *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96870,8 +98388,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *407 - - *408 + - *419 + - *420 - name: sha in: path required: true @@ -96925,7 +98443,7 @@ paths: description: Response content: application/json: - schema: *706 + schema: *718 examples: default: value: @@ -96979,8 +98497,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -96992,7 +98510,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -97012,14 +98530,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &707 + schema: &719 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -97087,8 +98605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: false content: @@ -97114,7 +98632,7 @@ paths: description: Response content: application/json: - schema: *707 + schema: *719 examples: default: value: @@ -97141,8 +98659,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -97162,8 +98680,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -97242,8 +98760,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -97251,7 +98769,7 @@ paths: application/json: schema: type: array - items: &708 + items: &720 title: Tag protection description: Tag protection type: object @@ -97303,8 +98821,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -97327,7 +98845,7 @@ paths: description: Response content: application/json: - schema: *708 + schema: *720 examples: default: value: @@ -97358,8 +98876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -97396,8 +98914,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *407 - - *408 + - *419 + - *420 - name: ref in: path required: true @@ -97433,8 +98951,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *407 - - *408 + - *419 + - *420 - *17 - *19 responses: @@ -97444,9 +98962,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - default: *333 + default: *343 headers: Link: *40 '404': *6 @@ -97466,8 +98984,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *407 - - *408 + - *419 + - *420 - *19 - *17 responses: @@ -97475,7 +98993,7 @@ paths: description: Response content: application/json: - schema: &709 + schema: &721 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -97487,7 +99005,7 @@ paths: required: - names examples: - default: &710 + default: &722 value: names: - octocat @@ -97510,8 +99028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -97542,9 +99060,9 @@ paths: description: Response content: application/json: - schema: *709 + schema: *721 examples: - default: *710 + default: *722 '404': *6 '422': *7 x-github: @@ -97565,9 +99083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *407 - - *408 - - &711 + - *419 + - *420 + - &723 name: per description: The time frame to display results for. in: query @@ -97596,7 +99114,7 @@ paths: example: 128 clones: type: array - items: &712 + items: &724 title: Traffic type: object properties: @@ -97683,8 +99201,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -97774,8 +99292,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *407 - - *408 + - *419 + - *420 responses: '200': description: Response @@ -97835,9 +99353,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *407 - - *408 - - *711 + - *419 + - *420 + - *723 responses: '200': description: Response @@ -97856,7 +99374,7 @@ paths: example: 3782 views: type: array - items: *712 + items: *724 required: - uniques - count @@ -97933,8 +99451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *407 - - *408 + - *419 + - *420 requestBody: required: true content: @@ -97970,7 +99488,7 @@ paths: description: Response content: application/json: - schema: *224 + schema: *234 examples: default: value: @@ -98208,8 +99726,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -98232,8 +99750,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -98255,8 +99773,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -98282,8 +99800,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *407 - - *408 + - *419 + - *420 - name: ref in: path required: true @@ -98375,9 +99893,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *432 examples: - default: *422 + default: *434 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -98418,7 +99936,7 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: default: value: @@ -98528,7 +100046,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &720 + - &732 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -98537,7 +100055,7 @@ paths: schema: type: string example: members - - &725 + - &737 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -98548,7 +100066,7 @@ paths: default: 1 format: int32 example: 1 - - &726 + - &738 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -98590,7 +100108,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &714 + items: &727 allOf: - type: object required: @@ -98665,7 +100183,7 @@ paths: - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 displayName: User 2 - meta: &727 + meta: &739 type: object description: The metadata associated with the creation/updates to the user. @@ -98725,31 +100243,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &715 + '400': &728 description: Bad request content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 - '401': &716 - description: Authorization failure - '403': &717 + schema: *725 + '401': *726 + '403': &729 description: Permission denied - '429': &718 + '429': &730 description: Too many requests content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 - '500': &719 + schema: *725 + '500': &731 description: Internal server error content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 + schema: *725 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -98773,7 +100290,7 @@ paths: required: true content: application/json: - schema: &723 + schema: &735 type: object required: - schemas @@ -98829,9 +100346,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *714 + schema: *727 examples: - group: &721 + group: &733 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -98850,13 +100367,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *715 - '401': *716 - '403': *717 - '409': &724 + '400': *728 + '401': *726 + '403': *729 + '409': &736 description: Duplicate record detected - '429': *718 - '500': *719 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -98873,7 +100390,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group parameters: - - &722 + - &734 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -98881,22 +100398,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *720 + - *732 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *714 + schema: *727 examples: - default: *721 - '400': *715 - '401': *716 - '403': *717 + default: *733 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '429': *718 - '500': *719 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -98915,13 +100432,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group parameters: - - *722 + - *734 - *41 requestBody: required: true content: application/json: - schema: *723 + schema: *735 examples: group: summary: Group @@ -98947,17 +100464,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *714 + schema: *727 examples: - group: *721 - groupWithMembers: *721 - '400': *715 - '401': *716 - '403': *717 + group: *733 + groupWithMembers: *733 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '409': *724 - '429': *718 - '500': *719 + '409': *736 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -98981,13 +100498,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group parameters: - - *722 + - *734 - *41 requestBody: required: true content: application/json: - schema: &734 + schema: &746 type: object required: - Operations @@ -99047,17 +100564,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *714 + schema: *727 examples: - updateGroup: *721 - addMembers: *721 - '400': *715 - '401': *716 - '403': *717 + updateGroup: *733 + addMembers: *733 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '409': *724 - '429': *718 - '500': *719 + '409': *736 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99073,17 +100590,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise parameters: - - *722 + - *734 - *41 responses: '204': description: Group was deleted, no content - '400': *715 - '401': *716 - '403': *717 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '429': *718 - '500': *719 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99117,8 +100634,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *725 - - *726 + - *737 + - *738 - *41 responses: '200': @@ -99151,7 +100668,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &729 + items: &741 allOf: - type: object required: @@ -99230,7 +100747,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &728 + roles: &740 type: array description: The roles assigned to the user. items: @@ -99286,7 +100803,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *727 + meta: *739 startIndex: type: integer description: A starting index for the returned page @@ -99323,11 +100840,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *715 - '401': *716 - '403': *717 - '429': *718 - '500': *719 + '400': *728 + '401': *726 + '403': *729 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99351,7 +100868,7 @@ paths: required: true content: application/json: - schema: &732 + schema: &744 type: object required: - schemas @@ -99433,9 +100950,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *728 + roles: *740 examples: - user: &733 + user: &745 summary: User value: schemas: @@ -99482,9 +100999,9 @@ paths: description: User has been created content: application/scim+json: - schema: *729 + schema: *741 examples: - user: &730 + user: &742 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -99510,13 +101027,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 - enterpriseOwner: *730 - '400': *715 - '401': *716 - '403': *717 - '409': *724 - '429': *718 - '500': *719 + enterpriseOwner: *742 + '400': *728 + '401': *726 + '403': *729 + '409': *736 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99533,7 +101050,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user parameters: - - &731 + - &743 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -99546,15 +101063,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *729 + schema: *741 examples: - default: *730 - '400': *715 - '401': *716 - '403': *717 + default: *742 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '429': *718 - '500': *719 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99576,30 +101093,30 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user parameters: - - *731 + - *743 - *41 requestBody: required: true content: application/json: - schema: *732 + schema: *744 examples: - user: *733 + user: *745 responses: '200': description: User was updated content: application/scim+json: - schema: *729 + schema: *741 examples: - user: *730 - '400': *715 - '401': *716 - '403': *717 + user: *742 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '409': *724 - '429': *718 - '500': *719 + '409': *736 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99634,13 +101151,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user parameters: - - *731 + - *743 - *41 requestBody: required: true content: application/json: - schema: *734 + schema: *746 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -99680,18 +101197,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *729 + schema: *741 examples: - userMultiValuedProperties: *730 - userSingleValuedProperties: *730 - disableUser: *730 - '400': *715 - '401': *716 - '403': *717 + userMultiValuedProperties: *742 + userSingleValuedProperties: *742 + disableUser: *742 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '409': *724 - '429': *718 - '500': *719 + '409': *736 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99711,17 +101228,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise parameters: - - *731 + - *743 - *41 responses: '204': description: User was deleted, no content - '400': *715 - '401': *716 - '403': *717 + '400': *728 + '401': *726 + '403': *729 '404': *6 - '429': *718 - '500': *719 + '429': *730 + '500': *731 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -99754,7 +101271,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *73 + - *75 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -99808,7 +101325,7 @@ paths: example: 1 Resources: type: array - items: &735 + items: &747 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -100039,22 +101556,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &736 + '404': &748 description: Resource not found content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 - '403': &737 + schema: *725 + '403': &749 description: Forbidden content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 - '400': *715 - '429': *718 + schema: *725 + '400': *728 + '429': *730 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -100074,15 +101591,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *73 + - *75 responses: '201': description: Response content: application/scim+json: - schema: *735 + schema: *747 examples: - default: &738 + default: &750 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -100105,17 +101622,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *736 - '403': *737 - '500': *719 + '404': *748 + '403': *749 + '500': *731 '409': description: Conflict content: application/json: - schema: *713 + schema: *725 application/scim+json: - schema: *713 - '400': *715 + schema: *725 + '400': *728 requestBody: required: true content: @@ -100212,18 +101729,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - - *73 - - *731 + - *75 + - *743 responses: '200': description: Response content: application/scim+json: - schema: *735 + schema: *747 examples: - default: *738 - '404': *736 - '403': *737 + default: *750 + '404': *748 + '403': *749 '304': *37 x-github: githubCloudOnly: true @@ -100246,19 +101763,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *73 - - *731 + - *75 + - *743 responses: '200': description: Response content: application/scim+json: - schema: *735 + schema: *747 examples: - default: *738 + default: *750 '304': *37 - '404': *736 - '403': *737 + '404': *748 + '403': *749 requestBody: required: true content: @@ -100370,20 +101887,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - - *73 - - *731 + - *75 + - *743 responses: '200': description: Response content: application/scim+json: - schema: *735 + schema: *747 examples: - default: *738 + default: *750 '304': *37 - '404': *736 - '403': *737 - '400': *715 + '404': *748 + '403': *749 + '400': *728 '429': description: Response content: @@ -100473,13 +101990,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - - *73 - - *731 + - *75 + - *743 responses: '204': description: Response - '404': *736 - '403': *737 + '404': *748 + '403': *749 '304': *37 x-github: githubCloudOnly: true @@ -100594,7 +102111,7 @@ paths: html_url: type: string format: uri - repository: *224 + repository: *234 score: type: number file_size: @@ -100612,7 +102129,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &739 + text_matches: &751 title: Search Result Text Matches type: array items: @@ -100726,7 +102243,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *157 + '503': *159 '422': *15 '403': *29 x-github: @@ -100775,7 +102292,7 @@ paths: enum: - author-date - committer-date - - &740 + - &752 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -100846,7 +102363,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *464 + properties: *476 nullable: true comment_count: type: integer @@ -100866,7 +102383,7 @@ paths: url: type: string format: uri - verification: *589 + verification: *601 required: - author - committer @@ -100885,7 +102402,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *464 + properties: *476 nullable: true parents: type: array @@ -100898,12 +102415,12 @@ paths: type: string sha: type: string - repository: *224 + repository: *234 score: type: number node_id: type: string - text_matches: *739 + text_matches: *751 required: - sha - node_id @@ -101086,7 +102603,7 @@ paths: - interactions - created - updated - - *740 + - *752 - *17 - *19 - name: advanced_search @@ -101183,7 +102700,8 @@ paths: description: type: string nullable: true - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: type: string state_reason: @@ -101200,8 +102718,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *532 - required: *533 + properties: *544 + required: *545 nullable: true comments: type: integer @@ -101215,7 +102733,7 @@ paths: type: string format: date-time nullable: true - text_matches: *739 + text_matches: *751 pull_request: type: object properties: @@ -101248,10 +102766,10 @@ paths: type: string score: type: number - author_association: *167 + author_association: *171 draft: type: boolean - repository: *64 + repository: *66 body_html: type: string body_text: @@ -101259,7 +102777,7 @@ paths: timeline_url: type: string format: uri - type: *316 + type: *326 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -101269,9 +102787,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 - reactions: *168 + properties: *169 + required: *170 + reactions: *172 required: - assignee - closed_at @@ -101387,7 +102905,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *157 + '503': *159 '422': *15 '304': *37 '403': *29 @@ -101443,7 +102961,7 @@ paths: enum: - created - updated - - *740 + - *752 - *17 - *19 responses: @@ -101487,7 +103005,7 @@ paths: nullable: true score: type: number - text_matches: *739 + text_matches: *751 required: - id - node_id @@ -101573,7 +103091,7 @@ paths: - forks - help-wanted-issues - updated - - *740 + - *752 - *17 - *19 responses: @@ -101792,8 +103310,8 @@ paths: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true permissions: type: object @@ -101812,7 +103330,7 @@ paths: - admin - pull - push - text_matches: *739 + text_matches: *751 temp_clone_token: type: string allow_merge_commit: @@ -102014,7 +103532,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *157 + '503': *159 '422': *15 '304': *37 x-github: @@ -102113,7 +103631,7 @@ paths: type: string format: uri nullable: true - text_matches: *739 + text_matches: *751 related: type: array nullable: true @@ -102306,7 +103824,7 @@ paths: - followers - repositories - joined - - *740 + - *752 - *17 - *19 responses: @@ -102410,7 +103928,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *739 + text_matches: *751 blog: type: string nullable: true @@ -102469,7 +103987,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *157 + '503': *159 '422': *15 x-github: githubCloudOnly: false @@ -102489,7 +104007,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &742 + - &755 name: team_id description: The unique identifier of the team. in: path @@ -102501,9 +104019,9 @@ paths: description: Response content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '404': *6 x-github: githubCloudOnly: false @@ -102530,7 +104048,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *742 + - *755 requestBody: required: true content: @@ -102593,16 +104111,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '201': description: Response content: application/json: - schema: *388 + schema: *400 examples: - default: *389 + default: *401 '404': *6 '422': *15 '403': *29 @@ -102630,7 +104148,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *742 + - *755 responses: '204': description: Response @@ -102661,8 +104179,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *742 - - *91 + - *755 + - *93 - *17 - *19 responses: @@ -102672,9 +104190,9 @@ paths: application/json: schema: type: array - items: *390 + items: *402 examples: - default: *743 + default: *756 headers: Link: *40 x-github: @@ -102703,7 +104221,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *742 + - *755 requestBody: required: true content: @@ -102737,9 +104255,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: *391 + default: *403 x-github: triggersNotification: true githubCloudOnly: false @@ -102766,16 +104284,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *742 - - *392 + - *755 + - *404 responses: '200': description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: *391 + default: *403 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102800,8 +104318,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *742 - - *392 + - *755 + - *404 requestBody: required: false content: @@ -102824,9 +104342,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *402 examples: - default: *744 + default: *757 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102851,8 +104369,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *742 - - *392 + - *755 + - *404 responses: '204': description: Response @@ -102881,9 +104399,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *742 - - *392 - - *91 + - *755 + - *404 + - *93 - *17 - *19 responses: @@ -102893,9 +104411,9 @@ paths: application/json: schema: type: array - items: *393 + items: *405 examples: - default: *745 + default: *758 headers: Link: *40 x-github: @@ -102924,8 +104442,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *742 - - *392 + - *755 + - *404 requestBody: required: true content: @@ -102947,9 +104465,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: *394 + default: *406 x-github: triggersNotification: true githubCloudOnly: false @@ -102976,17 +104494,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *742 - - *392 - - *395 + - *755 + - *404 + - *407 responses: '200': description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: *394 + default: *406 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103011,9 +104529,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *742 - - *392 - - *395 + - *755 + - *404 + - *407 requestBody: required: true content: @@ -103035,9 +104553,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *405 examples: - default: *746 + default: *759 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103062,9 +104580,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *742 - - *392 - - *395 + - *755 + - *404 + - *407 responses: '204': description: Response @@ -103093,9 +104611,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *742 - - *392 - - *395 + - *755 + - *404 + - *407 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -103121,9 +104639,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 x-github: @@ -103152,9 +104670,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *742 - - *392 - - *395 + - *755 + - *404 + - *407 requestBody: required: true content: @@ -103186,9 +104704,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -103214,8 +104732,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *742 - - *392 + - *755 + - *404 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -103241,9 +104759,9 @@ paths: application/json: schema: type: array - items: *396 + items: *408 examples: - default: *398 + default: *410 headers: Link: *40 x-github: @@ -103272,8 +104790,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *742 - - *392 + - *755 + - *404 requestBody: required: true content: @@ -103305,9 +104823,9 @@ paths: description: Response content: application/json: - schema: *396 + schema: *408 examples: - default: *397 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103331,7 +104849,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *742 + - *755 - *17 - *19 responses: @@ -103341,9 +104859,9 @@ paths: application/json: schema: type: array - items: *313 + items: *323 examples: - default: *314 + default: *324 headers: Link: *40 x-github: @@ -103369,7 +104887,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *742 + - *755 - name: role description: Filters members returned by their role in the team. in: query @@ -103392,7 +104910,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '404': *6 @@ -103420,8 +104938,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *742 - - *246 + - *755 + - *256 responses: '204': description: if user is a member @@ -103457,8 +104975,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *742 - - *246 + - *755 + - *256 responses: '204': description: Response @@ -103497,8 +105015,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *742 - - *246 + - *755 + - *256 responses: '204': description: Response @@ -103534,16 +105052,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *742 - - *246 + - *755 + - *256 responses: '200': description: Response content: application/json: - schema: *404 + schema: *416 examples: - response-if-user-is-a-team-maintainer: *747 + response-if-user-is-a-team-maintainer: *760 '404': *6 x-github: githubCloudOnly: false @@ -103576,8 +105094,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *742 - - *246 + - *755 + - *256 requestBody: required: false content: @@ -103602,9 +105120,9 @@ paths: description: Response content: application/json: - schema: *404 + schema: *416 examples: - response-if-users-membership-with-team-is-now-pending: *748 + response-if-users-membership-with-team-is-now-pending: *761 '403': description: Forbidden if team synchronization is set up '422': @@ -103638,8 +105156,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *742 - - *246 + - *755 + - *256 responses: '204': description: Response @@ -103667,7 +105185,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *742 + - *755 - *17 - *19 responses: @@ -103677,9 +105195,9 @@ paths: application/json: schema: type: array - items: *405 + items: *417 examples: - default: *749 + default: *762 headers: Link: *40 '404': *6 @@ -103705,16 +105223,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *742 - - *406 + - *755 + - *418 responses: '200': description: Response content: application/json: - schema: *405 + schema: *417 examples: - default: *750 + default: *763 '404': description: Not Found if project is not managed by this team x-github: @@ -103738,8 +105256,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *742 - - *406 + - *755 + - *418 requestBody: required: false content: @@ -103806,8 +105324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *742 - - *406 + - *755 + - *418 responses: '204': description: Response @@ -103834,7 +105352,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *742 + - *755 - *17 - *19 responses: @@ -103844,9 +105362,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 '404': *6 @@ -103876,15 +105394,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *742 - - *407 - - *408 + - *755 + - *419 + - *420 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *751 + schema: *764 examples: alternative-response-with-extra-repository-information: value: @@ -104035,9 +105553,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *742 - - *407 - - *408 + - *755 + - *419 + - *420 requestBody: required: false content: @@ -104087,9 +105605,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *742 - - *407 - - *408 + - *755 + - *419 + - *420 responses: '204': description: Response @@ -104118,15 +105636,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team-legacy parameters: - - *742 + - *755 responses: '200': description: Response content: application/json: - schema: *409 + schema: *421 examples: - default: *410 + default: *422 '403': *29 '404': *6 x-github: @@ -104153,7 +105671,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections-legacy parameters: - - *742 + - *755 requestBody: required: true content: @@ -104210,7 +105728,7 @@ paths: description: Response content: application/json: - schema: *409 + schema: *421 examples: default: value: @@ -104241,7 +105759,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *742 + - *755 - *17 - *19 responses: @@ -104251,9 +105769,9 @@ paths: application/json: schema: type: array - items: *255 + items: *265 examples: - response-if-child-teams-exist: *752 + response-if-child-teams-exist: *765 headers: Link: *40 '404': *6 @@ -104286,7 +105804,7 @@ paths: application/json: schema: oneOf: - - &754 + - &767 title: Private User description: Private User type: object @@ -104489,7 +106007,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *753 + - *766 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -104642,7 +106160,7 @@ paths: description: Response content: application/json: - schema: *754 + schema: *767 examples: default: value: @@ -104721,7 +106239,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 '304': *37 '404': *6 '403': *29 @@ -104744,7 +106262,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *246 + - *256 responses: '204': description: If the user is blocked @@ -104772,7 +106290,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *246 + - *256 responses: '204': description: Response @@ -104796,7 +106314,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *246 + - *256 responses: '204': description: Response @@ -104845,11 +106363,11 @@ paths: type: integer codespaces: type: array - items: *322 + items: *332 examples: - default: *323 + default: *333 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -104986,21 +106504,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '401': *25 '403': *29 '404': *6 - '503': *157 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105040,7 +106558,7 @@ paths: type: integer secrets: type: array - items: &755 + items: &768 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -105080,7 +106598,7 @@ paths: - visibility - selected_repositories_url examples: - default: *520 + default: *532 headers: Link: *40 x-github: @@ -105150,13 +106668,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *234 + - *244 responses: '200': description: Response content: application/json: - schema: *755 + schema: *768 examples: default: value: @@ -105186,7 +106704,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *234 + - *244 requestBody: required: true content: @@ -105231,7 +106749,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -105259,7 +106777,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *234 + - *244 responses: '204': description: Response @@ -105284,7 +106802,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *234 + - *244 responses: '200': description: Response @@ -105300,13 +106818,13 @@ paths: type: integer repositories: type: array - items: *224 + items: *234 examples: - default: *756 + default: *769 '401': *25 '403': *29 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105327,7 +106845,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *234 + - *244 requestBody: required: true content: @@ -105359,7 +106877,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105381,7 +106899,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *234 + - *244 - name: repository_id in: path required: true @@ -105393,7 +106911,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105414,7 +106932,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *234 + - *244 - name: repository_id in: path required: true @@ -105426,7 +106944,7 @@ paths: '401': *25 '403': *29 '404': *6 - '500': *88 + '500': *90 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105446,17 +106964,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 responses: '200': description: Response content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -105480,7 +106998,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 requestBody: required: false content: @@ -105510,9 +107028,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '401': *25 '403': *29 '404': *6 @@ -105534,11 +107052,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 responses: '202': *39 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -105563,13 +107081,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 responses: '202': description: Response content: application/json: - schema: &757 + schema: &770 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -105610,7 +107128,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &758 + default: &771 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -105618,7 +107136,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -105642,7 +107160,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *324 + - *334 - name: export_id in: path required: true @@ -105655,9 +107173,9 @@ paths: description: Response content: application/json: - schema: *757 + schema: *770 examples: - default: *758 + default: *771 '404': *6 x-github: githubCloudOnly: false @@ -105678,7 +107196,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *324 + - *334 responses: '200': description: Response @@ -105694,11 +107212,11 @@ paths: type: integer machines: type: array - items: *759 + items: *772 examples: - default: *760 + default: *773 '304': *37 - '500': *88 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -105725,7 +107243,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *324 + - *334 requestBody: required: true content: @@ -105775,13 +107293,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *420 + repository: *432 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *518 - required: *519 + properties: *530 + required: *531 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -106555,17 +108073,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 responses: '200': description: Response content: application/json: - schema: *322 + schema: *332 examples: - default: *517 + default: *529 '304': *37 - '500': *88 + '500': *90 '400': *14 '401': *25 '402': @@ -106575,7 +108093,7 @@ paths: schema: *3 '403': *29 '404': *6 - '409': *99 + '409': *101 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106595,16 +108113,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *324 + - *334 responses: '200': description: Response content: application/json: - schema: *322 + schema: *332 examples: - default: *517 - '500': *88 + default: *529 + '500': *90 '401': *25 '403': *29 '404': *6 @@ -106633,9 +108151,9 @@ paths: application/json: schema: type: array - items: *334 + items: *344 examples: - default: &773 + default: &785 value: - id: 197 name: hello_docker @@ -106736,7 +108254,7 @@ paths: application/json: schema: type: array - items: &761 + items: &774 title: Email description: Email type: object @@ -106801,9 +108319,9 @@ paths: application/json: schema: type: array - items: *761 + items: *774 examples: - default: &775 + default: &787 value: - email: octocat@github.com verified: true @@ -106878,7 +108396,7 @@ paths: application/json: schema: type: array - items: *761 + items: *774 examples: default: value: @@ -106988,7 +108506,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '304': *37 @@ -107021,7 +108539,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 '304': *37 @@ -107043,7 +108561,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *246 + - *256 responses: '204': description: if the person is followed by the authenticated user @@ -107073,7 +108591,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *246 + - *256 responses: '204': description: Response @@ -107098,7 +108616,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *246 + - *256 responses: '204': description: Response @@ -107134,7 +108652,7 @@ paths: application/json: schema: type: array - items: &762 + items: &775 title: GPG Key description: A unique encryption key type: object @@ -107265,7 +108783,7 @@ paths: - subkeys - revoked examples: - default: &789 + default: &801 value: - id: 3 name: Octocat's GPG Key @@ -107350,9 +108868,9 @@ paths: description: Response content: application/json: - schema: *762 + schema: *775 examples: - default: &763 + default: &776 value: id: 3 name: Octocat's GPG Key @@ -107409,7 +108927,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &764 + - &777 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -107421,9 +108939,9 @@ paths: description: Response content: application/json: - schema: *762 + schema: *775 examples: - default: *763 + default: *776 '404': *6 '304': *37 '403': *29 @@ -107446,7 +108964,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *764 + - *777 responses: '204': description: Response @@ -107635,9 +109153,9 @@ paths: type: string repositories: type: array - items: *64 + items: *66 examples: - default: *765 + default: *229 headers: Link: *40 '404': *6 @@ -107662,7 +109180,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *219 + - *206 responses: '204': description: Response @@ -107688,7 +109206,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *219 + - *206 responses: '204': description: Response @@ -107722,12 +109240,12 @@ paths: application/json: schema: anyOf: - - *311 + - *321 - type: object properties: {} additionalProperties: false examples: - default: *312 + default: *322 '204': description: Response when there are no restrictions x-github: @@ -107751,7 +109269,7 @@ paths: required: true content: application/json: - schema: *600 + schema: *612 examples: default: value: @@ -107762,7 +109280,7 @@ paths: description: Response content: application/json: - schema: *311 + schema: *321 examples: default: value: @@ -107843,7 +109361,7 @@ paths: - closed - all default: open - - *319 + - *329 - name: sort description: What to sort results by. in: query @@ -107855,8 +109373,8 @@ paths: - updated - comments default: created - - *91 - - *170 + - *93 + - *174 - *17 - *19 responses: @@ -107866,9 +109384,9 @@ paths: application/json: schema: type: array - items: *180 + items: *184 examples: - default: *320 + default: *330 headers: Link: *40 '404': *6 @@ -107901,7 +109419,7 @@ paths: application/json: schema: type: array - items: &766 + items: &778 title: Key description: Key type: object @@ -108002,9 +109520,9 @@ paths: description: Response content: application/json: - schema: *766 + schema: *778 examples: - default: &767 + default: &779 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -108037,15 +109555,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *629 + - *641 responses: '200': description: Response content: application/json: - schema: *766 + schema: *778 examples: - default: *767 + default: *779 '404': *6 '304': *37 '403': *29 @@ -108068,7 +109586,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *629 + - *641 responses: '204': description: Response @@ -108101,7 +109619,7 @@ paths: application/json: schema: type: array - items: &768 + items: &780 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -108158,7 +109676,7 @@ paths: - id - type - login - plan: *184 + plan: *188 required: - billing_cycle - next_billing_date @@ -108169,7 +109687,7 @@ paths: - account - plan examples: - default: &769 + default: &781 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -108231,9 +109749,9 @@ paths: application/json: schema: type: array - items: *768 + items: *780 examples: - default: *769 + default: *781 headers: Link: *40 '304': *37 @@ -108273,7 +109791,7 @@ paths: application/json: schema: type: array - items: *325 + items: *335 examples: default: value: @@ -108375,13 +109893,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *73 + - *75 responses: '200': description: Response content: application/json: - schema: *325 + schema: *335 examples: default: value: @@ -108439,7 +109957,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *73 + - *75 requestBody: required: true content: @@ -108464,7 +109982,7 @@ paths: description: Response content: application/json: - schema: *325 + schema: *335 examples: default: value: @@ -108532,7 +110050,7 @@ paths: application/json: schema: type: array - items: *327 + items: *337 examples: default: value: @@ -108785,7 +110303,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *337 examples: default: value: @@ -108965,7 +110483,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *328 + - *338 - name: exclude in: query required: false @@ -108978,7 +110496,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *337 examples: default: value: @@ -109172,7 +110690,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *328 + - *338 responses: '302': description: Response @@ -109198,7 +110716,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *328 + - *338 responses: '204': description: Response @@ -109227,8 +110745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *328 - - *770 + - *338 + - *782 responses: '204': description: Response @@ -109252,7 +110770,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *328 + - *338 - *17 - *19 responses: @@ -109262,9 +110780,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 '404': *6 @@ -109299,9 +110817,9 @@ paths: application/json: schema: type: array - items: *59 + items: *61 examples: - default: *771 + default: *783 headers: Link: *40 '304': *37 @@ -109343,7 +110861,7 @@ paths: - docker - nuget - container - - *772 + - *784 - *19 - *17 responses: @@ -109353,10 +110871,10 @@ paths: application/json: schema: type: array - items: *334 + items: *344 examples: - default: *773 - '400': *774 + default: *785 + '400': *786 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -109376,16 +110894,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *336 - - *337 + - *346 + - *347 responses: '200': description: Response content: application/json: - schema: *334 + schema: *344 examples: - default: &790 + default: &802 value: id: 40201 name: octo-name @@ -109498,8 +111016,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *336 - - *337 + - *346 + - *347 responses: '204': description: Response @@ -109529,8 +111047,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *336 - - *337 + - *346 + - *347 - name: token description: package token schema: @@ -109562,8 +111080,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - - *336 - - *337 + - *346 + - *347 - *19 - *17 - name: state @@ -109583,7 +111101,7 @@ paths: application/json: schema: type: array - items: *338 + items: *348 examples: default: value: @@ -109632,15 +111150,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *336 - - *337 - - *339 + - *346 + - *347 + - *349 responses: '200': description: Response content: application/json: - schema: *338 + schema: *348 examples: default: value: @@ -109676,9 +111194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *336 - - *337 - - *339 + - *346 + - *347 + - *349 responses: '204': description: Response @@ -109708,9 +111226,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *336 - - *337 - - *339 + - *346 + - *347 + - *349 responses: '204': description: Response @@ -109766,7 +111284,7 @@ paths: description: Response content: application/json: - schema: *350 + schema: *360 examples: default: value: @@ -109838,9 +111356,9 @@ paths: application/json: schema: type: array - items: *761 + items: *774 examples: - default: *775 + default: *787 headers: Link: *40 '304': *37 @@ -109951,9 +111469,9 @@ paths: application/json: schema: type: array - items: *64 + items: *66 examples: - default: &782 + default: &794 summary: Default response value: - id: 1296269 @@ -110257,9 +111775,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *432 examples: - default: *422 + default: *434 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -110297,9 +111815,9 @@ paths: application/json: schema: type: array - items: *602 + items: *614 examples: - default: *776 + default: *788 headers: Link: *40 '304': *37 @@ -110322,12 +111840,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *315 + - *325 responses: '204': description: Response '403': *29 - '409': *99 + '409': *101 '404': *6 '304': *37 x-github: @@ -110345,11 +111863,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *315 + - *325 responses: '204': description: Response - '409': *99 + '409': *101 '304': *37 '404': *6 '403': *29 @@ -110378,7 +111896,7 @@ paths: application/json: schema: type: array - items: &777 + items: &789 title: Social account description: Social media account type: object @@ -110393,7 +111911,7 @@ paths: - provider - url examples: - default: &778 + default: &790 value: - provider: twitter url: https://twitter.com/github @@ -110455,9 +111973,9 @@ paths: application/json: schema: type: array - items: *777 + items: *789 examples: - default: *778 + default: *790 '422': *15 '304': *37 '404': *6 @@ -110544,7 +112062,7 @@ paths: application/json: schema: type: array - items: &779 + items: &791 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -110564,7 +112082,7 @@ paths: - title - created_at examples: - default: &791 + default: &803 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -110630,9 +112148,9 @@ paths: description: Response content: application/json: - schema: *779 + schema: *791 examples: - default: &780 + default: &792 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -110663,7 +112181,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - - &781 + - &793 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -110675,9 +112193,9 @@ paths: description: Response content: application/json: - schema: *779 + schema: *791 examples: - default: *780 + default: *792 '404': *6 '304': *37 '403': *29 @@ -110700,7 +112218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - - *781 + - *793 responses: '204': description: Response @@ -110729,7 +112247,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &792 + - &804 name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed @@ -110742,7 +112260,7 @@ paths: - created - updated default: created - - *91 + - *93 - *17 - *19 responses: @@ -110752,13 +112270,13 @@ paths: application/json: schema: type: array - items: *64 + items: *66 examples: - default-response: *782 + default-response: *794 application/vnd.github.v3.star+json: schema: type: array - items: &793 + items: &805 title: Starred Repository description: Starred Repository type: object @@ -110766,7 +112284,7 @@ paths: starred_at: type: string format: date-time - repo: *64 + repo: *66 required: - starred_at - repo @@ -110914,8 +112432,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response if this repository is starred by you @@ -110943,8 +112461,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -110968,8 +112486,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *407 - - *408 + - *419 + - *420 responses: '204': description: Response @@ -111002,9 +112520,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 '304': *37 @@ -111041,7 +112559,7 @@ paths: application/json: schema: type: array - items: *388 + items: *400 examples: default: value: @@ -111119,7 +112637,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *186 + - *190 responses: '200': description: Response @@ -111127,10 +112645,10 @@ paths: application/json: schema: oneOf: - - *754 - - *753 + - *767 + - *766 examples: - default-response: &784 + default-response: &796 summary: Default response value: login: octocat @@ -111165,7 +112683,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &785 + response-with-git-hub-plan-information: &797 summary: Response with GitHub plan information value: login: octocat @@ -111225,7 +112743,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *783 + - *795 - *17 responses: '200': @@ -111236,7 +112754,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: example: ; rel="next" @@ -111266,7 +112784,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *246 + - *256 responses: '200': description: Response @@ -111274,11 +112792,11 @@ paths: application/json: schema: oneOf: - - *754 - - *753 + - *767 + - *766 examples: - default-response: *784 - response-with-git-hub-plan-information: *785 + default-response: *796 + response-with-git-hub-plan-information: *797 '404': *6 x-github: githubCloudOnly: false @@ -111302,9 +112820,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *89 - - *90 - - *246 + - *91 + - *92 + - *256 requestBody: required: true content: @@ -111327,8 +112845,8 @@ paths: required: - subject_digests examples: - default: *786 - withPredicateType: *787 + default: *798 + withPredicateType: *799 responses: '200': description: Response @@ -111381,7 +112899,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *788 + default: *800 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111399,7 +112917,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-in-bulk parameters: - - *246 + - *256 requestBody: required: true content: @@ -111464,7 +112982,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *246 + - *256 - name: subject_digest description: Subject Digest in: path @@ -111495,7 +113013,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#delete-attestations-by-id parameters: - - *246 + - *256 - name: attestation_id description: Attestation ID in: path @@ -111531,9 +113049,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations parameters: - *17 - - *89 - - *90 - - *246 + - *91 + - *92 + - *256 - name: subject_digest description: Subject Digest in: path @@ -111583,12 +113101,12 @@ paths: bundle_url: type: string examples: - default: *460 + default: *472 '201': description: Response content: application/json: - schema: *235 + schema: *245 examples: default: value: @@ -111614,7 +113132,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *246 + - *256 responses: '200': description: Response @@ -111622,9 +113140,9 @@ paths: application/json: schema: type: array - items: *334 + items: *344 examples: - default: *773 + default: *785 '403': *29 '401': *25 x-github: @@ -111647,7 +113165,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -111657,7 +113175,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -111728,8 +113246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *246 - - *73 + - *256 + - *75 - *17 - *19 responses: @@ -111739,7 +113257,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -111818,7 +113336,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -111828,7 +113346,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -111895,7 +113413,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -111907,7 +113425,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -111926,7 +113444,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *246 + - *256 - *17 - *19 responses: @@ -111938,7 +113456,7 @@ paths: type: array items: *4 examples: - default: *321 + default: *331 headers: Link: *40 x-github: @@ -111957,7 +113475,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - - *246 + - *256 - name: target_user in: path required: true @@ -111984,8 +113502,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *246 - - *170 + - *256 + - *174 - *17 - *19 responses: @@ -111995,9 +113513,9 @@ paths: application/json: schema: type: array - items: *171 + items: *175 examples: - default: *172 + default: *176 headers: Link: *40 '422': *15 @@ -112018,7 +113536,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -112028,9 +113546,9 @@ paths: application/json: schema: type: array - items: *762 + items: *775 examples: - default: *789 + default: *801 headers: Link: *40 x-github: @@ -112054,7 +113572,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *246 + - *256 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -112126,7 +113644,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *246 + - *256 responses: '200': description: Response @@ -112134,7 +113652,7 @@ paths: application/json: schema: *22 examples: - default: *599 + default: *611 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112152,7 +113670,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -112207,7 +113725,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -112217,9 +113735,9 @@ paths: application/json: schema: type: array - items: *59 + items: *61 examples: - default: *771 + default: *783 headers: Link: *40 x-github: @@ -112258,8 +113776,8 @@ paths: - docker - nuget - container - - *772 - - *246 + - *784 + - *256 - *19 - *17 responses: @@ -112269,12 +113787,12 @@ paths: application/json: schema: type: array - items: *334 + items: *344 examples: - default: *773 + default: *785 '403': *29 '401': *25 - '400': *774 + '400': *786 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112294,17 +113812,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *336 - - *337 - - *246 + - *346 + - *347 + - *256 responses: '200': description: Response content: application/json: - schema: *334 + schema: *344 examples: - default: *790 + default: *802 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112325,9 +113843,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *336 - - *337 - - *246 + - *346 + - *347 + - *256 responses: '204': description: Response @@ -112359,9 +113877,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *336 - - *337 - - *246 + - *346 + - *347 + - *256 - name: token description: package token schema: @@ -112393,9 +113911,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *336 - - *337 - - *246 + - *346 + - *347 + - *256 responses: '200': description: Response @@ -112403,7 +113921,7 @@ paths: application/json: schema: type: array - items: *338 + items: *348 examples: default: value: @@ -112461,16 +113979,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-version-for-a-user parameters: - - *336 - - *337 - - *339 - - *246 + - *346 + - *347 + - *349 + - *256 responses: '200': description: Response content: application/json: - schema: *338 + schema: *348 examples: default: value: @@ -112505,10 +114023,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *336 - - *337 - - *246 - - *339 + - *346 + - *347 + - *256 + - *349 responses: '204': description: Response @@ -112540,10 +114058,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *336 - - *337 - - *246 - - *339 + - *346 + - *347 + - *256 + - *349 responses: '204': description: Response @@ -112569,7 +114087,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/projects#list-user-projects parameters: - - *246 + - *256 - name: state description: Indicates the state of the projects to return. in: query @@ -112590,7 +114108,7 @@ paths: application/json: schema: type: array - items: *350 + items: *360 examples: default: value: @@ -112652,7 +114170,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -112662,7 +114180,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -112741,7 +114259,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -112751,7 +114269,7 @@ paths: application/json: schema: type: array - items: *192 + items: *196 examples: default: value: @@ -112828,7 +114346,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *246 + - *256 - name: type description: Limit results to repositories of the specified type. in: query @@ -112871,9 +114389,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -112897,15 +114415,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *246 + - *256 responses: '200': description: Response content: application/json: - schema: *375 + schema: *387 examples: - default: *376 + default: *388 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112927,15 +114445,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *246 + - *256 responses: '200': description: Response content: application/json: - schema: *380 + schema: *392 examples: - default: *381 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112957,15 +114475,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *246 + - *256 responses: '200': description: Response content: application/json: - schema: *382 + schema: *394 examples: - default: *383 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -112985,11 +114503,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - - *246 - - *199 - - *200 - - *201 - - *202 + - *256 + - *209 + - *210 + - *211 + - *212 responses: '200': description: Response when getting a billing usage report @@ -113059,8 +114577,8 @@ paths: repositoryName: user/example '400': *14 '403': *29 - '500': *88 - '503': *157 + '500': *90 + '503': *159 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -113078,7 +114596,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -113088,9 +114606,9 @@ paths: application/json: schema: type: array - items: *777 + items: *789 examples: - default: *778 + default: *790 headers: Link: *40 x-github: @@ -113110,7 +114628,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -113120,9 +114638,9 @@ paths: application/json: schema: type: array - items: *779 + items: *791 examples: - default: *791 + default: *803 headers: Link: *40 x-github: @@ -113146,9 +114664,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *246 - - *792 - - *91 + - *256 + - *804 + - *93 - *17 - *19 responses: @@ -113159,11 +114677,11 @@ paths: schema: anyOf: - type: array - items: *793 + items: *805 - type: array - items: *64 + items: *66 examples: - default-response: *782 + default-response: *794 headers: Link: *40 x-github: @@ -113182,7 +114700,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *246 + - *256 - *17 - *19 responses: @@ -113192,9 +114710,9 @@ paths: application/json: schema: type: array - items: *224 + items: *234 examples: - default: *340 + default: *350 headers: Link: *40 x-github: @@ -113322,7 +114840,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &794 + enterprise: &806 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -113380,7 +114898,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &795 + installation: &807 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -113399,7 +114917,7 @@ x-webhooks: required: - id - node_id - organization: &796 + organization: &808 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -113459,13 +114977,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &797 + repository: &809 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &834 + properties: &846 id: description: Unique identifier of the repository example: 42 @@ -113485,8 +115003,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *181 - required: *182 + properties: *185 + required: *186 nullable: true organization: title: Simple User @@ -114148,7 +115666,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &835 + required: &847 - archive_url - assignees_url - blobs_url @@ -114299,10 +115817,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -114378,11 +115896,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - rule: &798 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + rule: &810 title: branch protection rule description: The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) @@ -114605,11 +116123,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - rule: *798 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + rule: *810 sender: *4 required: - action @@ -114792,11 +116310,11 @@ x-webhooks: - everyone required: - from - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - rule: *798 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + rule: *810 sender: *4 required: - action @@ -114867,7 +116385,7 @@ x-webhooks: required: true content: application/json: - schema: &801 + schema: &813 title: Exemption request cancellation event type: object properties: @@ -114875,11 +116393,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - exemption_request: &799 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + exemption_request: &811 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -115112,7 +116630,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &800 + items: &812 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -115220,7 +116738,7 @@ x-webhooks: required: true content: application/json: - schema: &802 + schema: &814 title: Exemption request completed event type: object properties: @@ -115228,11 +116746,11 @@ x-webhooks: type: string enum: - completed - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - exemption_request: *799 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + exemption_request: *811 sender: *4 required: - action @@ -115302,7 +116820,7 @@ x-webhooks: required: true content: application/json: - schema: &803 + schema: &815 title: Exemption request created event type: object properties: @@ -115310,11 +116828,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - exemption_request: *799 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + exemption_request: *811 sender: *4 required: - action @@ -115384,7 +116902,7 @@ x-webhooks: required: true content: application/json: - schema: &804 + schema: &816 title: Exemption response dismissed event type: object properties: @@ -115392,12 +116910,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - exemption_request: *799 - exemption_response: *800 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + exemption_request: *811 + exemption_response: *812 sender: *4 required: - action @@ -115469,7 +116987,7 @@ x-webhooks: required: true content: application/json: - schema: &805 + schema: &817 title: Exemption response submitted event type: object properties: @@ -115477,12 +116995,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - exemption_request: *799 - exemption_response: *800 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + exemption_request: *811 + exemption_response: *812 sender: *4 required: - action @@ -115555,7 +117073,7 @@ x-webhooks: required: true content: application/json: - schema: *801 + schema: *813 responses: '200': description: Return a 200 status to indicate that the data was received @@ -115622,7 +117140,7 @@ x-webhooks: required: true content: application/json: - schema: *802 + schema: *814 responses: '200': description: Return a 200 status to indicate that the data was received @@ -115689,7 +117207,7 @@ x-webhooks: required: true content: application/json: - schema: *803 + schema: *815 responses: '200': description: Return a 200 status to indicate that the data was received @@ -115756,7 +117274,7 @@ x-webhooks: required: true content: application/json: - schema: *804 + schema: *816 responses: '200': description: Return a 200 status to indicate that the data was received @@ -115824,7 +117342,7 @@ x-webhooks: required: true content: application/json: - schema: *805 + schema: *817 responses: '200': description: Return a 200 status to indicate that the data was received @@ -115902,7 +117420,7 @@ x-webhooks: type: string enum: - completed - check_run: &807 + check_run: &819 title: CheckRun description: A check performed on the code of a given code change type: object @@ -115955,8 +117473,8 @@ x-webhooks: type: string pull_requests: type: array - items: *479 - repository: *224 + items: *491 + repository: *234 status: example: completed type: string @@ -115993,7 +117511,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *806 + deployment: *818 details_url: example: https://example.com type: string @@ -116043,7 +117561,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *479 + items: *491 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -116078,9 +117596,9 @@ x-webhooks: - output - app - pull_requests - installation: *795 - organization: *796 - repository: *797 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - check_run @@ -116473,10 +117991,10 @@ x-webhooks: type: string enum: - created - check_run: *807 - installation: *795 - organization: *796 - repository: *797 + check_run: *819 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - check_run @@ -116872,10 +118390,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *807 - installation: *795 - organization: *796 - repository: *797 + check_run: *819 + installation: *807 + organization: *808 + repository: *809 requested_action: description: The action requested by the user. type: object @@ -117280,10 +118798,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *807 - installation: *795 - organization: *796 - repository: *797 + check_run: *819 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - check_run @@ -118260,10 +119778,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -118933,10 +120451,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -119600,10 +121118,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -119766,7 +121284,7 @@ x-webhooks: required: - login - id - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -119911,20 +121429,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &808 + commit_oid: &820 description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - enterprise: *794 - installation: *795 - organization: *796 - ref: &809 + enterprise: *806 + installation: *807 + organization: *808 + ref: &821 description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string - repository: *797 + repository: *809 sender: *4 required: - action @@ -120086,7 +121604,7 @@ x-webhooks: required: - login - id - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -120316,12 +121834,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *808 - enterprise: *794 - installation: *795 - organization: *796 - ref: *809 - repository: *797 + commit_oid: *820 + enterprise: *806 + installation: *807 + organization: *808 + ref: *821 + repository: *809 sender: *4 required: - action @@ -120416,7 +121934,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -120584,12 +122102,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *808 - enterprise: *794 - installation: *795 - organization: *796 - ref: *809 - repository: *797 + commit_oid: *820 + enterprise: *806 + installation: *807 + organization: *808 + ref: *821 + repository: *809 sender: *4 required: - action @@ -120752,7 +122270,7 @@ x-webhooks: required: - login - id - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -120918,12 +122436,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *808 - enterprise: *794 - installation: *795 - organization: *796 - ref: *809 - repository: *797 + commit_oid: *820 + enterprise: *806 + installation: *807 + organization: *808 + ref: *821 + repository: *809 sender: *4 required: - action @@ -121020,7 +122538,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -121188,16 +122706,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *797 + repository: *809 sender: *4 required: - action @@ -121291,7 +122809,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *492 + dismissed_comment: *504 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -121431,12 +122949,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *808 - enterprise: *794 - installation: *795 - organization: *796 - ref: *809 - repository: *797 + commit_oid: *820 + enterprise: *806 + installation: *807 + organization: *808 + ref: *821 + repository: *809 sender: *4 required: - action @@ -121693,10 +123211,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -121776,18 +123294,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *796 - pusher_type: &810 + organization: *808 + pusher_type: &822 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &811 + ref: &823 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -121797,7 +123315,7 @@ x-webhooks: enum: - tag - branch - repository: *797 + repository: *809 sender: *4 required: - ref @@ -121879,10 +123397,10 @@ x-webhooks: type: string enum: - created - definition: *119 - enterprise: *794 - installation: *795 - organization: *796 + definition: *121 + enterprise: *806 + installation: *807 + organization: *808 sender: *4 required: - action @@ -121967,9 +123485,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 sender: *4 required: - action @@ -122046,10 +123564,10 @@ x-webhooks: type: string enum: - promote_to_enterprise - definition: *119 - enterprise: *794 - installation: *795 - organization: *796 + definition: *121 + enterprise: *806 + installation: *807 + organization: *808 sender: *4 required: - action @@ -122126,10 +123644,10 @@ x-webhooks: type: string enum: - updated - definition: *119 - enterprise: *794 - installation: *795 - organization: *796 + definition: *121 + enterprise: *806 + installation: *807 + organization: *808 sender: *4 required: - action @@ -122206,19 +123724,19 @@ x-webhooks: type: string enum: - updated - enterprise: *794 - installation: *795 - repository: *797 - organization: *796 + enterprise: *806 + installation: *807 + repository: *809 + organization: *808 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *352 + items: *362 old_property_values: type: array description: The old custom property values for the repository. - items: *352 + items: *362 required: - action - repository @@ -122294,18 +123812,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *794 - installation: *795 - organization: *796 - pusher_type: *810 - ref: *811 + enterprise: *806 + installation: *807 + organization: *808 + pusher_type: *822 + ref: *823 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *797 + repository: *809 sender: *4 required: - ref @@ -122389,11 +123907,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122477,11 +123995,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122565,11 +124083,11 @@ x-webhooks: type: string enum: - created - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122651,11 +124169,11 @@ x-webhooks: type: string enum: - dismissed - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122737,11 +124255,11 @@ x-webhooks: type: string enum: - fixed - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122824,11 +124342,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122910,11 +124428,11 @@ x-webhooks: type: string enum: - reopened - alert: *549 - installation: *795 - organization: *796 - enterprise: *794 - repository: *797 + alert: *561 + installation: *807 + organization: *808 + enterprise: *806 + repository: *809 sender: *4 required: - action @@ -122991,9 +124509,9 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - key: &812 + enterprise: *806 + installation: *807 + key: &824 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -123029,8 +124547,8 @@ x-webhooks: - verified - created_at - read_only - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -123107,11 +124625,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - key: *812 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + key: *824 + organization: *808 + repository: *809 sender: *4 required: - action @@ -123672,12 +125190,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - workflow: &816 + workflow: &828 title: Workflow type: object nullable: true @@ -124403,13 +125921,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *555 + deployment: *567 pull_requests: type: array - items: *649 - repository: *797 - organization: *796 - installation: *795 + items: *661 + repository: *809 + organization: *808 + installation: *807 sender: *4 responses: '200': @@ -124480,7 +125998,7 @@ x-webhooks: type: string enum: - approved - approver: &813 + approver: &825 type: object properties: avatar_url: @@ -124523,11 +126041,11 @@ x-webhooks: type: string comment: type: string - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - reviewers: &814 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + reviewers: &826 type: array items: type: object @@ -124606,7 +126124,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &815 + workflow_job_run: &827 type: object properties: conclusion: @@ -125337,18 +126855,18 @@ x-webhooks: type: string enum: - rejected - approver: *813 + approver: *825 comment: type: string - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - reviewers: *814 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + reviewers: *826 sender: *4 since: type: string - workflow_job_run: *815 + workflow_job_run: *827 workflow_job_runs: type: array items: @@ -126052,13 +127570,13 @@ x-webhooks: type: string enum: - requested - enterprise: *794 + enterprise: *806 environment: type: string - installation: *795 - organization: *796 - repository: *797 - requestor: &821 + installation: *807 + organization: *808 + repository: *809 + requestor: &833 title: User type: object nullable: true @@ -127957,12 +129475,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - workflow: *816 + workflow: *828 workflow_run: title: Deployment Workflow Run type: object @@ -128642,7 +130160,7 @@ x-webhooks: type: string enum: - answered - answer: &819 + answer: &831 type: object properties: author_association: @@ -128799,7 +130317,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &817 + discussion: &829 title: Discussion description: A Discussion in a repository. type: object @@ -129085,7 +130603,7 @@ x-webhooks: - id labels: type: array - items: *611 + items: *624 required: - repository_url - category @@ -129107,10 +130625,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129237,11 +130755,11 @@ x-webhooks: - from required: - category - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129324,11 +130842,11 @@ x-webhooks: type: string enum: - closed - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129410,7 +130928,7 @@ x-webhooks: type: string enum: - created - comment: &818 + comment: &830 type: object properties: author_association: @@ -129567,11 +131085,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129654,12 +131172,12 @@ x-webhooks: type: string enum: - deleted - comment: *818 - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + comment: *830 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129754,12 +131272,12 @@ x-webhooks: - from required: - body - comment: *818 - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + comment: *830 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129843,11 +131361,11 @@ x-webhooks: type: string enum: - created - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -129929,11 +131447,11 @@ x-webhooks: type: string enum: - deleted - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130033,11 +131551,11 @@ x-webhooks: type: string required: - from - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130119,10 +131637,10 @@ x-webhooks: type: string enum: - labeled - discussion: *817 - enterprise: *794 - installation: *795 - label: &820 + discussion: *829 + enterprise: *806 + installation: *807 + label: &832 title: Label type: object properties: @@ -130154,8 +131672,8 @@ x-webhooks: - color - default - description - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130238,11 +131756,11 @@ x-webhooks: type: string enum: - locked - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130324,11 +131842,11 @@ x-webhooks: type: string enum: - pinned - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130410,11 +131928,11 @@ x-webhooks: type: string enum: - reopened - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130499,16 +132017,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *817 - new_repository: *797 + new_discussion: *829 + new_repository: *809 required: - new_discussion - new_repository - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130591,10 +132109,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *817 - old_answer: *819 - organization: *796 - repository: *797 + discussion: *829 + old_answer: *831 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130676,12 +132194,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *817 - enterprise: *794 - installation: *795 - label: *820 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130764,11 +132282,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130850,11 +132368,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *817 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + discussion: *829 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -130923,7 +132441,7 @@ x-webhooks: required: true content: application/json: - schema: *803 + schema: *815 responses: '200': description: Return a 200 status to indicate that the data was received @@ -130986,7 +132504,7 @@ x-webhooks: required: true content: application/json: - schema: *805 + schema: *817 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131052,7 +132570,7 @@ x-webhooks: required: true content: application/json: - schema: *801 + schema: *813 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131118,7 +132636,7 @@ x-webhooks: required: true content: application/json: - schema: *802 + schema: *814 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131184,7 +132702,7 @@ x-webhooks: required: true content: application/json: - schema: *803 + schema: *815 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131250,7 +132768,7 @@ x-webhooks: required: true content: application/json: - schema: *804 + schema: *816 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131316,7 +132834,7 @@ x-webhooks: required: true content: application/json: - schema: *805 + schema: *817 responses: '200': description: Return a 200 status to indicate that the data was received @@ -131383,7 +132901,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *794 + enterprise: *806 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -132043,9 +133561,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *795 - organization: *796 - repository: *797 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - forkee @@ -132191,9 +133709,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pages: description: The pages that were updated. type: array @@ -132230,7 +133748,7 @@ x-webhooks: - action - sha - html_url - repository: *797 + repository: *809 sender: *4 required: - pages @@ -132306,10 +133824,10 @@ x-webhooks: type: string enum: - created - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories: &822 + organization: *808 + repositories: &834 description: An array of repository objects that the installation can access. type: array @@ -132335,8 +133853,8 @@ x-webhooks: - name - full_name - private - repository: *797 - requester: *821 + repository: *809 + requester: *833 sender: *4 required: - action @@ -132411,11 +133929,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories: *822 - repository: *797 + organization: *808 + repositories: *834 + repository: *809 requester: nullable: true sender: *4 @@ -132491,11 +134009,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories: *822 - repository: *797 + organization: *808 + repositories: *834 + repository: *809 requester: nullable: true sender: *4 @@ -132571,10 +134089,10 @@ x-webhooks: type: string enum: - added - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories_added: &823 + organization: *808 + repositories_added: &835 description: An array of repository objects, which were added to the installation. type: array @@ -132620,15 +134138,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *797 - repository_selection: &824 + repository: *809 + repository_selection: &836 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *821 + requester: *833 sender: *4 required: - action @@ -132707,10 +134225,10 @@ x-webhooks: type: string enum: - removed - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories_added: *823 + organization: *808 + repositories_added: *835 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -132737,9 +134255,9 @@ x-webhooks: - name - full_name - private - repository: *797 - repository_selection: *824 - requester: *821 + repository: *809 + repository_selection: *836 + requester: *833 sender: *4 required: - action @@ -132818,11 +134336,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories: *822 - repository: *797 + organization: *808 + repositories: *834 + repository: *809 requester: nullable: true sender: *4 @@ -133001,10 +134519,10 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 target_type: type: string @@ -133083,11 +134601,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *794 + enterprise: *806 installation: *22 - organization: *796 - repositories: *822 - repository: *797 + organization: *808 + repositories: *834 + repository: *809 requester: nullable: true sender: *4 @@ -133211,8 +134729,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *165 - required: *166 + properties: *169 + required: *170 reactions: title: Reactions type: object @@ -133339,8 +134857,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -134134,7 +135652,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134150,7 +135669,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -134483,8 +136002,8 @@ x-webhooks: - state - locked - assignee - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -134564,7 +136083,7 @@ x-webhooks: type: string enum: - deleted - comment: &825 + comment: &837 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -134729,8 +136248,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -135520,7 +137039,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135536,7 +137056,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -135871,8 +137391,8 @@ x-webhooks: - state - locked - assignee - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -135952,7 +137472,7 @@ x-webhooks: type: string enum: - edited - changes: &853 + changes: &867 description: The changes to the comment. type: object properties: @@ -135964,9 +137484,9 @@ x-webhooks: type: string required: - from - comment: *825 - enterprise: *794 - installation: *795 + comment: *837 + enterprise: *806 + installation: *807 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -136759,7 +138279,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136775,7 +138296,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -137108,8 +138629,8 @@ x-webhooks: - state - locked - assignee - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -137193,15 +138714,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *180 + blocked_issue: *184 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *180 - blocking_issue_repo: *64 - installation: *795 - organization: *796 - repository: *797 + blocking_issue: *184 + blocking_issue_repo: *66 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -137289,15 +138810,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *180 + blocked_issue: *184 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *180 - blocking_issue_repo: *64 - installation: *795 - organization: *796 - repository: *797 + blocking_issue: *184 + blocking_issue_repo: *66 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -137384,15 +138905,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *180 - blocked_issue_repo: *64 + blocked_issue: *184 + blocked_issue_repo: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *180 - installation: *795 - organization: *796 - repository: *797 + blocking_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -137480,15 +139001,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *180 - blocked_issue_repo: *64 + blocked_issue: *184 + blocked_issue_repo: *66 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *180 - installation: *795 - organization: *796 - repository: *797 + blocking_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -137573,10 +139094,10 @@ x-webhooks: type: string enum: - assigned - assignee: *821 - enterprise: *794 - installation: *795 - issue: &828 + assignee: *833 + enterprise: *806 + installation: *807 + issue: &840 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -138365,7 +139886,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138381,7 +139903,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -138482,8 +140004,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -138563,8 +140085,8 @@ x-webhooks: type: string enum: - closed - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -139358,7 +140880,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139374,7 +140897,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -139610,8 +141133,8 @@ x-webhooks: required: - state - closed_at - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -139690,8 +141213,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -140476,7 +141999,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140492,7 +142016,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -140592,8 +142116,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -140672,8 +142196,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -141480,7 +143004,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141496,7 +143021,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -141575,7 +143100,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &826 + milestone: &838 title: Milestone description: A collection of related issues and pull requests. type: object @@ -141713,8 +143238,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -141813,8 +143338,8 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -142603,7 +144128,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142616,7 +144142,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *316 + type: *326 title: description: Title of the issue type: string @@ -142720,9 +144246,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *820 - organization: *796 - repository: *797 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -142802,8 +144328,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -143591,7 +145117,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143604,7 +145131,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *316 + type: *326 title: description: Title of the issue type: string @@ -143708,9 +145235,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *820 - organization: *796 - repository: *797 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -143790,8 +145317,8 @@ x-webhooks: type: string enum: - locked - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -144603,7 +146130,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144616,7 +146144,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *316 + type: *326 title: description: Title of the issue type: string @@ -144697,8 +146225,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -144777,8 +146305,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -145584,7 +147112,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145600,7 +147129,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -145678,9 +147207,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *826 - organization: *796 - repository: *797 + milestone: *838 + organization: *808 + repository: *809 sender: *4 required: - action @@ -146548,7 +148077,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146641,7 +148171,7 @@ x-webhooks: required: - login - id - type: *316 + type: *326 required: - id - number @@ -147110,8 +148640,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -147900,7 +149430,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147916,7 +149447,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -148016,8 +149547,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -148097,9 +149628,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *794 - installation: *795 - issue: &827 + enterprise: *806 + installation: *807 + issue: &839 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -148882,7 +150413,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -148898,7 +150430,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -148998,8 +150530,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -149078,8 +150610,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149889,7 +151421,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149983,9 +151516,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *316 - organization: *796 - repository: *797 + type: *326 + organization: *808 + repository: *809 sender: *4 required: - action @@ -150851,7 +152384,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150867,7 +152401,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -151435,11 +152969,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *794 - installation: *795 - issue: *827 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *839 + organization: *808 + repository: *809 sender: *4 required: - action @@ -151519,12 +153053,12 @@ x-webhooks: type: string enum: - typed - enterprise: *794 - installation: *795 - issue: *828 - type: *316 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *840 + type: *326 + organization: *808 + repository: *809 sender: *4 required: - action @@ -151605,7 +153139,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &856 + assignee: &870 title: User type: object nullable: true @@ -151675,11 +153209,11 @@ x-webhooks: required: - login - id - enterprise: *794 - installation: *795 - issue: *828 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *840 + organization: *808 + repository: *809 sender: *4 required: - action @@ -151758,12 +153292,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *794 - installation: *795 - issue: *828 - label: *820 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *840 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -151843,8 +153377,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152654,7 +154188,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *741 + sub_issues_summary: *753 + issue_dependencies_summary: *754 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152670,7 +154205,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *316 + type: *326 updated_at: type: string format: date-time @@ -152748,8 +154283,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -152829,11 +154364,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *794 - installation: *795 - issue: *827 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *839 + organization: *808 + repository: *809 sender: *4 required: - action @@ -152912,12 +154447,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *794 - installation: *795 - issue: *828 - type: *316 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + issue: *840 + type: *326 + organization: *808 + repository: *809 sender: *4 required: - action @@ -152997,11 +154532,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - label: *820 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -153079,11 +154614,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - label: *820 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -153193,11 +154728,11 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - label: *820 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + label: *832 + organization: *808 + repository: *809 sender: *4 required: - action @@ -153279,9 +154814,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *794 - installation: *795 - marketplace_purchase: &829 + enterprise: *806 + installation: *807 + marketplace_purchase: &841 title: Marketplace Purchase type: object required: @@ -153364,8 +154899,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *796 - previous_marketplace_purchase: &830 + organization: *808 + previous_marketplace_purchase: &842 title: Marketplace Purchase type: object properties: @@ -153445,7 +154980,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *797 + repository: *809 sender: *4 required: - action @@ -153525,10 +155060,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *794 - installation: *795 - marketplace_purchase: *829 - organization: *796 + enterprise: *806 + installation: *807 + marketplace_purchase: *841 + organization: *808 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -153611,7 +155146,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *797 + repository: *809 sender: *4 required: - action @@ -153693,10 +155228,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *794 - installation: *795 - marketplace_purchase: *829 - organization: *796 + enterprise: *806 + installation: *807 + marketplace_purchase: *841 + organization: *808 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -153778,7 +155313,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *797 + repository: *809 sender: *4 required: - action @@ -153859,8 +155394,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 marketplace_purchase: title: Marketplace Purchase type: object @@ -153942,9 +155477,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *796 - previous_marketplace_purchase: *830 - repository: *797 + organization: *808 + previous_marketplace_purchase: *842 + repository: *809 sender: *4 required: - action @@ -154024,12 +155559,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *794 - installation: *795 - marketplace_purchase: *829 - organization: *796 - previous_marketplace_purchase: *830 - repository: *797 + enterprise: *806 + installation: *807 + marketplace_purchase: *841 + organization: *808 + previous_marketplace_purchase: *842 + repository: *809 sender: *4 required: - action @@ -154131,11 +155666,11 @@ x-webhooks: type: string required: - to - enterprise: *794 - installation: *795 - member: *821 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + member: *833 + organization: *808 + repository: *809 sender: *4 required: - action @@ -154235,11 +155770,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *794 - installation: *795 - member: *821 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + member: *833 + organization: *808 + repository: *809 sender: *4 required: - action @@ -154318,11 +155853,11 @@ x-webhooks: type: string enum: - removed - enterprise: *794 - installation: *795 - member: *821 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + member: *833 + organization: *808 + repository: *809 sender: *4 required: - action @@ -154400,11 +155935,11 @@ x-webhooks: type: string enum: - added - enterprise: *794 - installation: *795 - member: *821 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + member: *833 + organization: *808 + repository: *809 scope: description: The scope of the membership. Currently, can only be `team`. @@ -154480,7 +156015,7 @@ x-webhooks: required: - login - id - team: &831 + team: &843 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -154670,11 +156205,11 @@ x-webhooks: type: string enum: - removed - enterprise: *794 - installation: *795 - member: *821 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + member: *833 + organization: *808 + repository: *809 scope: description: The scope of the membership. Currently, can only be `team`. @@ -154751,7 +156286,7 @@ x-webhooks: required: - login - id - team: *831 + team: *843 required: - action - scope @@ -154833,8 +156368,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *795 - merge_group: &833 + installation: *807 + merge_group: &845 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -154853,15 +156388,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *832 + head_commit: *844 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -154947,10 +156482,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *795 - merge_group: *833 - organization: *796 - repository: *797 + installation: *807 + merge_group: *845 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155023,7 +156558,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 + enterprise: *806 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -155132,16 +156667,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *795 - organization: *796 + installation: *807 + organization: *808 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *834 - required: *835 + properties: *846 + required: *847 nullable: true sender: *4 required: @@ -155222,11 +156757,11 @@ x-webhooks: type: string enum: - closed - enterprise: *794 - installation: *795 - milestone: *826 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + milestone: *838 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155305,9 +156840,9 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - milestone: &836 + enterprise: *806 + installation: *807 + milestone: &848 title: Milestone description: A collection of related issues and pull requests. type: object @@ -155444,8 +156979,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155524,11 +157059,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - milestone: *826 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + milestone: *838 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155638,11 +157173,11 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - milestone: *826 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + milestone: *838 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155722,11 +157257,11 @@ x-webhooks: type: string enum: - opened - enterprise: *794 - installation: *795 - milestone: *836 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + milestone: *848 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155805,11 +157340,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *821 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + blocked_user: *833 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155888,11 +157423,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *821 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + blocked_user: *833 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -155971,9 +157506,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - membership: &837 + enterprise: *806 + installation: *807 + membership: &849 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -156080,8 +157615,8 @@ x-webhooks: - role - organization_url - user - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 required: - action @@ -156159,11 +157694,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *794 - installation: *795 - membership: *837 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + membership: *849 + organization: *808 + repository: *809 sender: *4 required: - action @@ -156242,8 +157777,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -156359,10 +157894,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 - user: *821 + user: *833 required: - action - invitation @@ -156440,11 +157975,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *794 - installation: *795 - membership: *837 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + membership: *849 + organization: *808 + repository: *809 sender: *4 required: - action @@ -156531,11 +158066,11 @@ x-webhooks: properties: from: type: string - enterprise: *794 - installation: *795 - membership: *837 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + membership: *849 + organization: *808 + repository: *809 sender: *4 required: - action @@ -156611,9 +158146,9 @@ x-webhooks: type: string enum: - published - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 package: description: Information about the package. type: object @@ -157112,7 +158647,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &838 + items: &850 title: Ruby Gems metadata type: object properties: @@ -157207,7 +158742,7 @@ x-webhooks: - owner - package_version - registry - repository: *797 + repository: *809 sender: *4 required: - action @@ -157283,9 +158818,9 @@ x-webhooks: type: string enum: - updated - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 package: description: Information about the package. type: object @@ -157638,7 +159173,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *838 + items: *850 source_url: type: string format: uri @@ -157708,7 +159243,7 @@ x-webhooks: - owner - package_version - registry - repository: *797 + repository: *809 sender: *4 required: - action @@ -157885,12 +159420,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *794 + enterprise: *806 id: type: integer - installation: *795 - organization: *796 - repository: *797 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - id @@ -157967,7 +159502,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &839 + personal_access_token_request: &851 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -158113,10 +159648,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *794 - organization: *796 + enterprise: *806 + organization: *808 sender: *4 - installation: *795 + installation: *807 required: - action - personal_access_token_request @@ -158193,11 +159728,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *839 - enterprise: *794 - organization: *796 + personal_access_token_request: *851 + enterprise: *806 + organization: *808 sender: *4 - installation: *795 + installation: *807 required: - action - personal_access_token_request @@ -158273,11 +159808,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *839 - enterprise: *794 - organization: *796 + personal_access_token_request: *851 + enterprise: *806 + organization: *808 sender: *4 - installation: *795 + installation: *807 required: - action - personal_access_token_request @@ -158352,11 +159887,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *839 - organization: *796 - enterprise: *794 + personal_access_token_request: *851 + organization: *808 + enterprise: *806 sender: *4 - installation: *795 + installation: *807 required: - action - personal_access_token_request @@ -158461,7 +159996,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *840 + last_response: *852 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -158493,8 +160028,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 zen: description: Random string of GitHub zen. @@ -158739,10 +160274,10 @@ x-webhooks: - from required: - note - enterprise: *794 - installation: *795 - organization: *796 - project_card: &841 + enterprise: *806 + installation: *807 + organization: *808 + project_card: &853 title: Project Card type: object properties: @@ -158861,7 +160396,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *797 + repository: *809 sender: *4 required: - action @@ -158942,11 +160477,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - project_card: *841 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project_card: *853 + repository: *809 sender: *4 required: - action @@ -159026,9 +160561,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 project_card: title: Project Card type: object @@ -159156,8 +160691,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *834 - required: *835 + properties: *846 + required: *847 nullable: true sender: *4 required: @@ -159251,11 +160786,11 @@ x-webhooks: - from required: - note - enterprise: *794 - installation: *795 - organization: *796 - project_card: *841 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project_card: *853 + repository: *809 sender: *4 required: - action @@ -159349,9 +160884,9 @@ x-webhooks: - from required: - column_id - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 project_card: allOf: - title: Project Card @@ -159541,7 +161076,7 @@ x-webhooks: type: string required: - after_id - repository: *797 + repository: *809 sender: *4 required: - action @@ -159621,10 +161156,10 @@ x-webhooks: type: string enum: - closed - enterprise: *794 - installation: *795 - organization: *796 - project: &843 + enterprise: *806 + installation: *807 + organization: *808 + project: &855 title: Project type: object properties: @@ -159748,7 +161283,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *797 + repository: *809 sender: *4 required: - action @@ -159828,10 +161363,10 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - project_column: &842 + enterprise: *806 + installation: *807 + organization: *808 + project_column: &854 title: Project Column type: object properties: @@ -159870,7 +161405,7 @@ x-webhooks: - name - created_at - updated_at - repository: *797 + repository: *809 sender: *4 required: - action @@ -159949,18 +161484,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - project_column: *842 + enterprise: *806 + installation: *807 + organization: *808 + project_column: *854 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *834 - required: *835 + properties: *846 + required: *847 nullable: true sender: *4 required: @@ -160050,11 +161585,11 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - organization: *796 - project_column: *842 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project_column: *854 + repository: *809 sender: *4 required: - action @@ -160134,11 +161669,11 @@ x-webhooks: type: string enum: - moved - enterprise: *794 - installation: *795 - organization: *796 - project_column: *842 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project_column: *854 + repository: *809 sender: *4 required: - action @@ -160218,11 +161753,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - project: *843 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project: *855 + repository: *809 sender: *4 required: - action @@ -160302,18 +161837,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - project: *843 + enterprise: *806 + installation: *807 + organization: *808 + project: *855 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *834 - required: *835 + properties: *846 + required: *847 nullable: true sender: *4 required: @@ -160415,11 +161950,11 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - organization: *796 - project: *843 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project: *855 + repository: *809 sender: *4 required: - action @@ -160498,11 +162033,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *794 - installation: *795 - organization: *796 - project: *843 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + project: *855 + repository: *809 sender: *4 required: - action @@ -160583,9 +162118,9 @@ x-webhooks: type: string enum: - closed - installation: *795 - organization: *796 - projects_v2: &844 + installation: *807 + organization: *808 + projects_v2: &856 title: Projects v2 Project description: A projects v2 project type: object @@ -160633,6 +162168,62 @@ x-webhooks: properties: *20 required: *21 nullable: true + state: + type: string + enum: + - open + - closed + latest_status_update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: &861 + id: + type: number + node_id: + type: string + project_node_id: + type: string + creator: *4 + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + start_date: + type: string + format: date + example: '2022-04-28' + target_date: + type: string + format: date + example: '2022-04-28' + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: &862 + - id + - node_id + - created_at + - updated_at + nullable: true + is_template: + type: boolean + description: Whether this project is a template required: - id - node_id @@ -160728,9 +162319,9 @@ x-webhooks: type: string enum: - created - installation: *795 - organization: *796 - projects_v2: *844 + installation: *807 + organization: *808 + projects_v2: *856 sender: *4 required: - action @@ -160811,9 +162402,9 @@ x-webhooks: type: string enum: - deleted - installation: *795 - organization: *796 - projects_v2: *844 + installation: *807 + organization: *808 + projects_v2: *856 sender: *4 required: - action @@ -160930,9 +162521,9 @@ x-webhooks: type: string to: type: string - installation: *795 - organization: *796 - projects_v2: *844 + installation: *807 + organization: *808 + projects_v2: *856 sender: *4 required: - action @@ -161015,7 +162606,7 @@ x-webhooks: type: string enum: - archived - changes: &848 + changes: &860 type: object properties: archived_at: @@ -161029,9 +162620,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *795 - organization: *796 - projects_v2_item: &845 + installation: *807 + organization: *808 + projects_v2_item: &857 title: Projects v2 Item description: An item belonging to a project type: object @@ -161165,9 +162756,9 @@ x-webhooks: nullable: true to: type: string - installation: *795 - organization: *796 - projects_v2_item: *845 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161249,9 +162840,9 @@ x-webhooks: type: string enum: - created - installation: *795 - organization: *796 - projects_v2_item: *845 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161332,9 +162923,9 @@ x-webhooks: type: string enum: - deleted - installation: *795 - organization: *796 - projects_v2_item: *845 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161440,7 +163031,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &846 + - &858 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -161458,7 +163049,7 @@ x-webhooks: required: - id - name - - &847 + - &859 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -161481,8 +163072,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *846 - - *847 + - *858 + - *859 required: - field_value - type: object @@ -161498,9 +163089,9 @@ x-webhooks: nullable: true required: - body - installation: *795 - organization: *796 - projects_v2_item: *845 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161595,9 +163186,9 @@ x-webhooks: to: type: string nullable: true - installation: *795 - organization: *796 - projects_v2_item: *845 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161680,10 +163271,10 @@ x-webhooks: type: string enum: - restored - changes: *848 - installation: *795 - organization: *796 - projects_v2_item: *845 + changes: *860 + installation: *807 + organization: *808 + projects_v2_item: *857 sender: *4 required: - action @@ -161765,9 +163356,9 @@ x-webhooks: type: string enum: - reopened - installation: *795 - organization: *796 - projects_v2: *844 + installation: *807 + organization: *808 + projects_v2: *856 sender: *4 required: - action @@ -161848,55 +163439,14 @@ x-webhooks: type: string enum: - created - installation: *795 - organization: *796 - projects_v2_status_update: &849 + installation: *807 + organization: *808 + projects_v2_status_update: &863 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: - id: - type: number - node_id: - type: string - project_node_id: - type: string - creator: *4 - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - status: - type: string - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - nullable: true - start_date: - type: string - format: date - example: '2022-04-28' - target_date: - type: string - format: date - example: '2022-04-28' - body: - description: Body of the status update - example: The project is off to a great start! - type: string - nullable: true - required: - - id - - node_id - - created_at - - updated_at + properties: *861 + required: *862 sender: *4 required: - action @@ -161977,9 +163527,9 @@ x-webhooks: type: string enum: - deleted - installation: *795 - organization: *796 - projects_v2_status_update: *849 + installation: *807 + organization: *808 + projects_v2_status_update: *863 sender: *4 required: - action @@ -162115,9 +163665,9 @@ x-webhooks: type: string format: date nullable: true - installation: *795 - organization: *796 - projects_v2_status_update: *849 + installation: *807 + organization: *808 + projects_v2_status_update: *863 sender: *4 required: - action @@ -162188,10 +163738,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - repository @@ -162268,13 +163818,13 @@ x-webhooks: type: string enum: - assigned - assignee: *821 - enterprise: *794 - installation: *795 - number: &850 + assignee: *833 + enterprise: *806 + installation: *807 + number: &864 description: The pull request number. type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -164557,7 +166107,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -164639,11 +166189,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -166921,7 +168471,7 @@ x-webhooks: - draft reason: type: string - repository: *797 + repository: *809 sender: *4 required: - action @@ -167003,11 +168553,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -169285,7 +170835,7 @@ x-webhooks: - draft reason: type: string - repository: *797 + repository: *809 sender: *4 required: - action @@ -169367,13 +170917,13 @@ x-webhooks: type: string enum: - closed - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: &851 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: &865 allOf: - - *649 + - *661 - type: object properties: allow_auto_merge: @@ -169435,7 +170985,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *797 + repository: *809 sender: *4 required: - action @@ -169516,12 +171066,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: *851 - repository: *797 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: *865 + repository: *809 sender: *4 required: - action @@ -169601,11 +171151,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *794 - milestone: *632 - number: *850 - organization: *796 - pull_request: &852 + enterprise: *806 + milestone: *644 + number: *864 + organization: *808 + pull_request: &866 title: Pull Request type: object properties: @@ -171868,7 +173418,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -171947,11 +173497,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -174233,7 +175783,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *797 + repository: *809 sender: *4 required: - action @@ -174357,12 +175907,12 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: *851 - repository: *797 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: *865 + repository: *809 sender: *4 required: - action @@ -174442,11 +175992,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -176713,7 +178263,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -176793,11 +178343,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *794 - installation: *795 - label: *820 - number: *850 - organization: *796 + enterprise: *806 + installation: *807 + label: *832 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -179079,7 +180629,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -179160,10 +180710,10 @@ x-webhooks: type: string enum: - locked - enterprise: *794 - installation: *795 - number: *850 - organization: *796 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -181443,7 +182993,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -181523,12 +183073,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *794 - milestone: *632 - number: *850 - organization: *796 - pull_request: *852 - repository: *797 + enterprise: *806 + milestone: *644 + number: *864 + organization: *808 + pull_request: *866 + repository: *809 sender: *4 required: - action @@ -181607,12 +183157,12 @@ x-webhooks: type: string enum: - opened - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: *851 - repository: *797 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: *865 + repository: *809 sender: *4 required: - action @@ -181693,12 +183243,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: *851 - repository: *797 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: *865 + repository: *809 sender: *4 required: - action @@ -181778,12 +183328,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *794 - installation: *795 - number: *850 - organization: *796 - pull_request: *851 - repository: *797 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 + pull_request: *865 + repository: *809 sender: *4 required: - action @@ -182149,9 +183699,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: type: object properties: @@ -184321,7 +185871,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *797 + repository: *809 sender: *4 required: - action @@ -184401,7 +185951,7 @@ x-webhooks: type: string enum: - deleted - comment: &854 + comment: &868 title: Pull Request Review Comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -184686,9 +186236,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: type: object properties: @@ -186846,7 +188396,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *797 + repository: *809 sender: *4 required: - action @@ -186926,11 +188476,11 @@ x-webhooks: type: string enum: - edited - changes: *853 - comment: *854 - enterprise: *794 - installation: *795 - organization: *796 + changes: *867 + comment: *868 + enterprise: *806 + installation: *807 + organization: *808 pull_request: type: object properties: @@ -189091,7 +190641,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *797 + repository: *809 sender: *4 required: - action @@ -189172,9 +190722,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: title: Simple Pull Request type: object @@ -191347,7 +192897,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *797 + repository: *809 review: description: The review that was affected. type: object @@ -191590,9 +193140,9 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: title: Simple Pull Request type: object @@ -193646,8 +195196,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *797 - review: &855 + repository: *809 + review: &869 description: The review that was affected. type: object properties: @@ -193876,12 +195426,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: description: The pull request number. type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -196164,7 +197714,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 requested_reviewer: title: User type: object @@ -196248,12 +197798,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: description: The pull request number. type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -198543,7 +200093,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 requested_team: title: Team description: Groups of organization members that gives permissions @@ -198735,12 +200285,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: description: The pull request number. type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -201025,7 +202575,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 requested_reviewer: title: User type: object @@ -201110,12 +202660,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *794 - installation: *795 + enterprise: *806 + installation: *807 number: description: The pull request number. type: integer - organization: *796 + organization: *808 pull_request: title: Pull Request type: object @@ -203391,7 +204941,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 requested_team: title: Team description: Groups of organization members that gives permissions @@ -203572,9 +205122,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: title: Simple Pull Request type: object @@ -205749,8 +207299,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *797 - review: *855 + repository: *809 + review: *869 sender: *4 required: - action @@ -205830,9 +207380,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: title: Simple Pull Request type: object @@ -207902,7 +209452,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *797 + repository: *809 sender: *4 thread: type: object @@ -208285,9 +209835,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 pull_request: title: Simple Pull Request type: object @@ -210343,7 +211893,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *797 + repository: *809 sender: *4 thread: type: object @@ -210729,10 +212279,10 @@ x-webhooks: type: string before: type: string - enterprise: *794 - installation: *795 - number: *850 - organization: *796 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -213003,7 +214553,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -213085,11 +214635,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *856 - enterprise: *794 - installation: *795 - number: *850 - organization: *796 + assignee: *870 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -215372,7 +216922,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -215451,11 +217001,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *794 - installation: *795 - label: *820 - number: *850 - organization: *796 + enterprise: *806 + installation: *807 + label: *832 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -217728,7 +219278,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -217809,10 +219359,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *794 - installation: *795 - number: *850 - organization: *796 + enterprise: *806 + installation: *807 + number: *864 + organization: *808 pull_request: title: Pull Request type: object @@ -220077,7 +221627,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *797 + repository: *809 sender: *4 required: - action @@ -220277,7 +221827,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *794 + enterprise: *806 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -220369,8 +221919,8 @@ x-webhooks: - url - author - committer - installation: *795 - organization: *796 + installation: *807 + organization: *808 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -220945,9 +222495,9 @@ x-webhooks: type: string enum: - published - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 registry_package: type: object properties: @@ -221393,7 +222943,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *838 + items: *850 summary: type: string tag_name: @@ -221447,7 +222997,7 @@ x-webhooks: - owner - package_version - registry - repository: *797 + repository: *809 sender: *4 required: - action @@ -221525,9 +223075,9 @@ x-webhooks: type: string enum: - updated - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 registry_package: type: object properties: @@ -221835,7 +223385,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *838 + items: *850 summary: type: string tag_name: @@ -221884,7 +223434,7 @@ x-webhooks: - owner - package_version - registry - repository: *797 + repository: *809 sender: *4 required: - action @@ -221961,10 +223511,10 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - release: &857 + enterprise: *806 + installation: *807 + organization: *808 + release: &871 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -222277,7 +223827,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *797 + repository: *809 sender: *4 required: - action @@ -222354,11 +223904,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - release: *857 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + release: *871 + repository: *809 sender: *4 required: - action @@ -222475,11 +224025,11 @@ x-webhooks: type: boolean required: - to - enterprise: *794 - installation: *795 - organization: *796 - release: *857 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + release: *871 + repository: *809 sender: *4 required: - action @@ -222557,9 +224107,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -222876,7 +224426,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *797 + repository: *809 sender: *4 required: - action @@ -222952,10 +224502,10 @@ x-webhooks: type: string enum: - published - enterprise: *794 - installation: *795 - organization: *796 - release: &858 + enterprise: *806 + installation: *807 + organization: *808 + release: &872 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -223269,7 +224819,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *797 + repository: *809 sender: *4 required: - action @@ -223345,11 +224895,11 @@ x-webhooks: type: string enum: - released - enterprise: *794 - installation: *795 - organization: *796 - release: *857 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + release: *871 + repository: *809 sender: *4 required: - action @@ -223425,11 +224975,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *794 - installation: *795 - organization: *796 - release: *858 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + release: *872 + repository: *809 sender: *4 required: - action @@ -223505,11 +225055,11 @@ x-webhooks: type: string enum: - published - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - repository_advisory: *701 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + repository_advisory: *713 sender: *4 required: - action @@ -223585,11 +225135,11 @@ x-webhooks: type: string enum: - reported - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - repository_advisory: *701 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + repository_advisory: *713 sender: *4 required: - action @@ -223665,10 +225215,10 @@ x-webhooks: type: string enum: - archived - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -223745,10 +225295,10 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -223826,10 +225376,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -223913,10 +225463,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -224028,10 +225578,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -224103,10 +225653,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 status: type: string @@ -224187,10 +225737,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -224267,10 +225817,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -224364,10 +225914,10 @@ x-webhooks: - name required: - repository - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -224447,11 +225997,11 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - repository_ruleset: *152 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + repository_ruleset: *154 sender: *4 required: - action @@ -224529,11 +226079,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - repository_ruleset: *152 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + repository_ruleset: *154 sender: *4 required: - action @@ -224611,11 +226161,11 @@ x-webhooks: type: string enum: - edited - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - repository_ruleset: *152 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + repository_ruleset: *154 changes: type: object properties: @@ -224634,16 +226184,16 @@ x-webhooks: properties: added: type: array - items: *126 + items: *128 deleted: type: array - items: *126 + items: *128 updated: type: array items: type: object properties: - condition: *126 + condition: *128 changes: type: object properties: @@ -224676,16 +226226,16 @@ x-webhooks: properties: added: type: array - items: *669 + items: *681 deleted: type: array - items: *669 + items: *681 updated: type: array items: type: object properties: - rule: *669 + rule: *681 changes: type: object properties: @@ -224919,10 +226469,10 @@ x-webhooks: - from required: - owner - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225000,10 +226550,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225081,7 +226631,7 @@ x-webhooks: type: string enum: - create - alert: &859 + alert: &873 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -225202,10 +226752,10 @@ x-webhooks: type: string enum: - open - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225411,10 +226961,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225492,11 +227042,11 @@ x-webhooks: type: string enum: - reopen - alert: *859 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + alert: *873 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225695,10 +227245,10 @@ x-webhooks: enum: - fixed - open - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225776,11 +227326,11 @@ x-webhooks: type: string enum: - created - alert: &860 + alert: &874 type: object properties: - number: *103 - created_at: *110 + number: *105 + created_at: *112 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -225788,8 +227338,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *108 - html_url: *109 + url: *110 + html_url: *111 locations_url: type: string format: uri @@ -225887,10 +227437,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -225971,11 +227521,11 @@ x-webhooks: type: string enum: - created - alert: *860 - installation: *795 - location: *861 - organization: *796 - repository: *797 + alert: *874 + installation: *807 + location: *875 + organization: *808 + repository: *809 sender: *4 required: - location @@ -226213,11 +227763,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *860 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + alert: *874 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -226295,11 +227845,11 @@ x-webhooks: type: string enum: - reopened - alert: *860 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + alert: *874 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -226377,11 +227927,11 @@ x-webhooks: type: string enum: - resolved - alert: *860 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + alert: *874 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -226459,11 +228009,11 @@ x-webhooks: type: string enum: - validated - alert: *860 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + alert: *874 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -226589,10 +228139,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *797 - enterprise: *794 - installation: *795 - organization: *796 + repository: *809 + enterprise: *806 + installation: *807 + organization: *808 sender: *4 required: - action @@ -226670,11 +228220,11 @@ x-webhooks: type: string enum: - published - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - security_advisory: &862 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + security_advisory: &876 description: The details of the security advisory, including summary, description, and severity. type: object @@ -226690,7 +228240,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *105 + cvss_severities: *107 cwes: type: array items: @@ -226857,11 +228407,11 @@ x-webhooks: type: string enum: - updated - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 - security_advisory: *862 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 + security_advisory: *876 sender: *4 required: - action @@ -226934,10 +228484,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -226954,7 +228504,7 @@ x-webhooks: required: - vector_string - score - cvss_severities: *105 + cvss_severities: *107 cwes: type: array items: @@ -227121,11 +228671,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *355 - enterprise: *794 - installation: *795 - organization: *796 - repository: *420 + security_and_analysis: *365 + enterprise: *806 + installation: *807 + organization: *808 + repository: *432 sender: *4 required: - changes @@ -227203,12 +228753,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: &863 + sponsorship: &877 type: object properties: created_at: @@ -227509,12 +229059,12 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: *863 + sponsorship: *877 required: - action - sponsorship @@ -227602,12 +229152,12 @@ x-webhooks: type: string required: - from - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: *863 + sponsorship: *877 required: - action - changes @@ -227684,17 +229234,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &864 + effective_date: &878 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: *863 + sponsorship: *877 required: - action - sponsorship @@ -227768,7 +229318,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &865 + changes: &879 type: object properties: tier: @@ -227812,13 +229362,13 @@ x-webhooks: - from required: - tier - effective_date: *864 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + effective_date: *878 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: *863 + sponsorship: *877 required: - action - changes @@ -227895,13 +229445,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *865 - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + changes: *879 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - sponsorship: *863 + sponsorship: *877 required: - action - changes @@ -227975,10 +229525,10 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -228061,10 +229611,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -228484,15 +230034,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *794 + enterprise: *806 id: description: The unique identifier of the status. type: integer - installation: *795 + installation: *807 name: type: string - organization: *796 - repository: *797 + organization: *808 + repository: *809 sender: *4 sha: description: The Commit SHA. @@ -228601,15 +230151,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *180 - parent_issue_repo: *64 + parent_issue: *184 + parent_issue_repo: *66 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *180 - installation: *795 - organization: *796 - repository: *797 + sub_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -228693,15 +230243,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *180 - parent_issue_repo: *64 + parent_issue: *184 + parent_issue_repo: *66 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *180 - installation: *795 - organization: *796 - repository: *797 + sub_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -228785,15 +230335,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *180 - sub_issue_repo: *64 + sub_issue: *184 + sub_issue_repo: *66 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *180 - installation: *795 - organization: *796 - repository: *797 + parent_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -228877,15 +230427,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *180 - sub_issue_repo: *64 + sub_issue: *184 + sub_issue_repo: *66 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *180 - installation: *795 - organization: *796 - repository: *797 + parent_issue: *184 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -228962,12 +230512,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - team: &866 + team: &880 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -229157,9 +230707,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 repository: title: Repository description: A git repository @@ -229617,7 +231167,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *880 required: - action - team @@ -229693,9 +231243,9 @@ x-webhooks: type: string enum: - created - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 repository: title: Repository description: A git repository @@ -230153,7 +231703,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *880 required: - action - team @@ -230230,9 +231780,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 repository: title: Repository description: A git repository @@ -230690,7 +232240,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *880 required: - action - team @@ -230834,9 +232384,9 @@ x-webhooks: - from required: - permissions - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 repository: title: Repository description: A git repository @@ -231294,7 +232844,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *880 required: - action - changes @@ -231372,9 +232922,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *794 - installation: *795 - organization: *796 + enterprise: *806 + installation: *807 + organization: *808 repository: title: Repository description: A git repository @@ -231832,7 +233382,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *866 + team: *880 required: - action - team @@ -231908,10 +233458,10 @@ x-webhooks: type: string enum: - started - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 required: - action @@ -231984,16 +233534,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *794 + enterprise: *806 inputs: type: object nullable: true additionalProperties: true - installation: *795 - organization: *796 + installation: *807 + organization: *808 ref: type: string - repository: *797 + repository: *809 sender: *4 workflow: type: string @@ -232075,10 +233625,10 @@ x-webhooks: type: string enum: - completed - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 workflow_job: allOf: @@ -232315,7 +233865,7 @@ x-webhooks: type: string required: - conclusion - deployment: *555 + deployment: *567 required: - action - repository @@ -232394,10 +233944,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 workflow_job: allOf: @@ -232657,7 +234207,7 @@ x-webhooks: required: - status - steps - deployment: *555 + deployment: *567 required: - action - repository @@ -232736,10 +234286,10 @@ x-webhooks: type: string enum: - queued - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 workflow_job: type: object @@ -232874,7 +234424,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *555 + deployment: *567 required: - action - repository @@ -232953,10 +234503,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 workflow_job: type: object @@ -233092,7 +234642,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *555 + deployment: *567 required: - action - repository @@ -233172,12 +234722,12 @@ x-webhooks: type: string enum: - completed - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - workflow: *816 + workflow: *828 workflow_run: title: Workflow Run type: object @@ -234176,12 +235726,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - workflow: *816 + workflow: *828 workflow_run: title: Workflow Run type: object @@ -235165,12 +236715,12 @@ x-webhooks: type: string enum: - requested - enterprise: *794 - installation: *795 - organization: *796 - repository: *797 + enterprise: *806 + installation: *807 + organization: *808 + repository: *809 sender: *4 - workflow: *816 + workflow: *828 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index e233267ace..9b6b76ca58 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -203,6 +203,10 @@ { "name": "credentials", "description": "Revoke compromised or leaked GitHub credentials." + }, + { + "name": "projects", + "description": "Endpoints to manage Projects using the REST API." } ], "servers": [ @@ -3044,6 +3048,301 @@ } } }, + "/enterprises/{enterprise}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an enterprise", + "description": "Gets artifact and log retention settings for an enterprise.", + "operationId": "enterprise-admin/get-artifact-and-log-retention-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the artifact and log retention settings", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + }, + "examples": { + "default": { + "summary": "Example response", + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/authorization_failure" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for an enterprise", + "description": "Sets artifact and log retention settings for an enterprise.", + "operationId": "enterprise-admin/set-artifact-and-log-retention-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "204": { + "description": "Successfully updated the artifact and log retention settings" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + }, + "examples": { + "default": { + "summary": "Set retention to 100 days", + "value": { + "days": 100 + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for an enterprise", + "description": "Gets the fork PR contributor approval policy for an enterprise.", + "operationId": "enterprise-admin/get-fork-pr-contributor-approval-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "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": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an enterprise", + "description": "Sets the fork PR contributor approval policy for an enterprise.", + "operationId": "enterprise-admin/set-fork-pr-contributor-approval-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "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": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for an enterprise", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise.", + "operationId": "enterprise-admin/get-private-repo-fork-pr-workflows-settings", + "tags": [ + "enterprise-admin" + ], + "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-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "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" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for an enterprise", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an enterprise.", + "operationId": "enterprise-admin/set-private-repo-fork-pr-workflows-settings", + "tags": [ + "enterprise-admin" + ], + "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-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "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" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/enterprises/{enterprise}/actions/permissions/organizations": { "get": { "summary": "List selected organizations enabled for GitHub Actions in an enterprise", @@ -3317,6 +3616,123 @@ } } }, + "/enterprises/{enterprise}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners permissions for an enterprise", + "description": "Gets the settings for whether organizations in the enterprise are allowed to manage self-hosted runners at the repository level.", + "operationId": "enterprise-admin/get-self-hosted-runners-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "disable_self_hosted_runners_for_all_orgs": { + "type": "boolean", + "description": "When true, repository-level runners will be disabled across all organizations in the enterprise" + } + }, + "required": [ + "disable_self_hosted_runners_for_all_orgs" + ] + }, + "examples": { + "default": { + "value": { + "disable_self_hosted_runners_for_all_orgs": false + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set self-hosted runners permissions for an enterprise", + "description": "Sets the settings for whether organizations in the enterprise are allowed to manage self-hosted runners at the repository level.", + "operationId": "enterprise-admin/set-self-hosted-runners-permissions", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "disable_self_hosted_runners_for_all_orgs": { + "type": "boolean", + "description": "When true, repository-level runners will be disabled across all organizations in the enterprise" + } + }, + "required": [ + "disable_self_hosted_runners_for_all_orgs" + ] + }, + "examples": { + "default": { + "summary": "Disable repository-level runners across all organizations", + "value": { + "disable_self_hosted_runners_for_all_orgs": true + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/enterprises/{enterprise}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an enterprise", @@ -7468,7 +7884,7 @@ "/enterprises/{enterprise}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -9186,6 +9602,198 @@ } } }, + "/enterprises/{enterprise}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List enterprise pattern configurations", + "description": "Lists the secret scanning pattern configurations for an enterprise.\n\nPersonal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-enterprise-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "patch": { + "summary": "Update enterprise pattern configurations", + "description": "Updates the secret scanning pattern configurations for an enterprise.\n\nPersonal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-enterprise-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, "/enterprises/{enterprise}/settings/billing/actions": { "get": { "summary": "Get GitHub Actions billing for an enterprise", @@ -13172,6 +13780,653 @@ "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", @@ -21241,7 +22496,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -25967,7 +27222,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -31150,6 +32405,198 @@ } } }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "patch": { + "summary": "Update organization pattern configurations", + "description": "Updates the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, "/orgs/{org}/security-advisories": { "get": { "summary": "List repository security advisories for an organization", @@ -37795,6 +39242,312 @@ } } }, + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for a repository", + "description": "Gets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + }, + "examples": { + "default": { + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for a repository", + "description": "Sets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + }, + "examples": { + "default": { + "summary": "Set retention days", + "value": { + "days": 90 + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for a repository", + "description": "Gets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-repository", + "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-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "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 a repository", + "description": "Sets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-repository", + "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-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "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" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for a repository", + "description": "Gets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "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 a repository", + "description": "Sets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-repository", + "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-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "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" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, "/repos/{owner}/{repo}/actions/permissions/selected-actions": { "get": { "summary": "Get allowed actions and reusable workflows for a repository", @@ -58902,6 +60655,320 @@ } } }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + "get": { + "summary": "List dependencies an issue is blocked by", + "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + }, + "post": { + "summary": "Add a dependency an issue is blocked by", + "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/add-blocked-by-dependency", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_id": { + "type": "integer", + "description": "The id of the issue that blocks the current issue" + } + }, + "required": [ + "issue_id" + ] + }, + "examples": { + "default": { + "value": { + "issue_id": 1 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { + "delete": { + "summary": "Remove dependency an issue is blocked by", + "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-dependency-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "name": "issue_id", + "in": "path", + "description": "The id of the blocking issue to remove as a dependency", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { + "get": { + "summary": "List dependencies an issue is blocking", + "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocking", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, "/repos/{owner}/{repo}/issues/{issue_number}/events": { "get": { "summary": "List issue events", @@ -113562,6 +115629,103 @@ "enabled_organizations" ] }, + "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." + } + } + }, "organization-simple": { "title": "Organization Simple", "description": "A GitHub organization.", @@ -119295,6 +121459,104 @@ } } }, + "secret-scanning-row-version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "secret-scanning-pattern-override": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + }, + "secret-scanning-pattern-configuration": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "$ref": "#/components/schemas/secret-scanning-pattern-override" + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "$ref": "#/components/schemas/secret-scanning-pattern-override" + } + } + } + }, "actions-billing-usage": { "type": "object", "properties": { @@ -120105,6 +122367,30 @@ "percent_completed" ] }, + "issue-dependencies-summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", @@ -120328,6 +122614,9 @@ }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" } }, "required": [ @@ -122659,6 +124948,27 @@ "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" + } + } + }, "nullable-simple-repository": { "title": "Simple Repository", "description": "A GitHub repository.", @@ -139158,6 +141468,9 @@ }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" } }, "required": [ @@ -145594,6 +147907,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "type": "string" }, @@ -152117,6 +154433,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -153494,6 +155813,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -155957,6 +158279,69 @@ "updated_at" ] }, + "nullable-projects-v2-status-update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, "projects-v2": { "title": "Projects v2 Project", "description": "A projects v2 project", @@ -156015,6 +158400,20 @@ }, "deleted_by": { "$ref": "#/components/schemas/nullable-simple-user" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "latest_status_update": { + "$ref": "#/components/schemas/nullable-projects-v2-status-update" + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" } }, "required": [ @@ -177794,6 +180193,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -179362,6 +181764,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -180939,6 +183344,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -182758,6 +185166,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -184188,6 +186599,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -185436,6 +187850,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -186677,6 +189094,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -187911,6 +190331,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -189171,6 +191594,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -190395,6 +192821,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -191600,6 +194029,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -193396,6 +195828,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -194683,6 +197118,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -195884,6 +198322,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -197880,6 +200321,9 @@ "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -290566,6 +293010,19 @@ "selected_actions_url": "https://api.github.com/enterprises/2/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 + } + }, "organization-targets": { "value": { "total_count": 1, @@ -292827,6 +295284,41 @@ } ] }, + "secret-scanning-pattern-configuration": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } + }, "actions-billing-usage": { "value": { "total_minutes_used": 305, @@ -294547,6 +297039,136 @@ "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", @@ -294735,136 +297357,6 @@ "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, @@ -323122,6 +325614,9 @@ } } }, + "authorization_failure": { + "description": "Authorization failure" + }, "actions_runner_jitconfig": { "description": "Response", "content": { @@ -323577,9 +326072,6 @@ } } }, - "authorization_failure": { - "description": "Authorization failure" - }, "permission_denied": { "description": "Permission denied" }, diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 33aa2aa21d..00fb16cf25 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -107,6 +107,8 @@ tags: description: Endpoints to manage campaigns via the REST API. - name: credentials description: Revoke compromised or leaked GitHub credentials. +- name: projects + description: Endpoints to manage Projects using the REST API. servers: - url: https://api.github.com externalDocs: @@ -2126,6 +2128,200 @@ paths: githubCloudOnly: true category: actions subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an enterprise + description: Gets artifact and log retention settings for an enterprise. + operationId: enterprise-admin/get-artifact-and-log-retention-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Successfully retrieved the artifact and log retention settings + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + examples: + default: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '401': + "$ref": "#/components/responses/authorization_failure" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an enterprise + description: Sets artifact and log retention settings for an enterprise. + operationId: enterprise-admin/set-artifact-and-log-retention-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Successfully updated the artifact and log retention settings + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + examples: + default: + summary: Set retention to 100 days + value: + days: 100 + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an enterprise + description: Gets the fork PR contributor approval policy for an enterprise. + operationId: enterprise-admin/get-fork-pr-contributor-approval-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an enterprise + description: Sets the fork PR contributor approval policy for an enterprise. + operationId: enterprise-admin/set-fork-pr-contributor-approval-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an enterprise + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an enterprise. + operationId: enterprise-admin/get-private-repo-fork-pr-workflows-settings + tags: + - enterprise-admin + 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-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an enterprise + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an enterprise. + operationId: enterprise-admin/set-private-repo-fork-pr-workflows-settings + tags: + - enterprise-admin + 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-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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 + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions "/enterprises/{enterprise}/actions/permissions/organizations": get: summary: List selected organizations enabled for GitHub Actions in an enterprise @@ -2319,6 +2515,86 @@ paths: githubCloudOnly: true category: actions subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners permissions for an enterprise + description: Gets the settings for whether organizations in the enterprise are + allowed to manage self-hosted runners at the repository level. + operationId: enterprise-admin/get-self-hosted-runners-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-self-hosted-runners-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + disable_self_hosted_runners_for_all_orgs: + type: boolean + description: When true, repository-level runners will be disabled + across all organizations in the enterprise + required: + - disable_self_hosted_runners_for_all_orgs + examples: + default: + value: + disable_self_hosted_runners_for_all_orgs: false + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners permissions for an enterprise + description: Sets the settings for whether organizations in the enterprise are + allowed to manage self-hosted runners at the repository level. + operationId: enterprise-admin/set-self-hosted-runners-permissions + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + disable_self_hosted_runners_for_all_orgs: + type: boolean + description: When true, repository-level runners will be disabled + across all organizations in the enterprise + required: + - disable_self_hosted_runners_for_all_orgs + examples: + default: + summary: Disable repository-level runners across all organizations + value: + disable_self_hosted_runners_for_all_orgs: true + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions "/enterprises/{enterprise}/actions/permissions/workflow": get: summary: Get default workflow permissions for an enterprise @@ -5325,7 +5601,7 @@ paths: For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. @@ -6489,6 +6765,137 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/secret-scanning/pattern-configurations": + get: + summary: List enterprise pattern configurations + description: |- + Lists the secret scanning pattern configurations for an enterprise. + + Personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-enterprise-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-enterprise-pattern-configurations + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + examples: + default: + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + patch: + summary: Update enterprise pattern configurations + description: |- + Updates the secret scanning pattern configurations for an enterprise. + + Personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-enterprise-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-enterprise-pattern-configurations + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" "/enterprises/{enterprise}/settings/billing/actions": get: summary: Get GitHub Actions billing for an enterprise @@ -9317,6 +9724,458 @@ 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 @@ -15348,7 +16207,7 @@ paths: Only organization owners can view assigned seats. Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -18726,7 +19585,7 @@ paths: Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -22527,6 +23386,137 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/pattern-configurations": + get: + summary: List organization pattern configurations + description: |- + Lists the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + examples: + default: + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + patch: + summary: Update organization pattern configurations + description: |- + Updates the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization @@ -27396,6 +28386,215 @@ paths: previews: [] category: actions subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for a repository + description: |- + Gets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository + 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-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + examples: + default: + value: + days: 90 + maximum_allowed_days: 365 + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for a repository + description: |- + Sets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-repository + 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-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Empty response for successful settings update + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + examples: + default: + summary: Set retention days + value: + days: 90 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for a repository + description: |- + Gets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository + 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-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + 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 a repository + description: |- + Sets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository + 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-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + 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 + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for a repository + description: |- + Gets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository + 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-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + 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 a repository + description: |- + Sets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository + 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-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + 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 + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/repos/{owner}/{repo}/actions/permissions/selected-actions": get: summary: Get allowed actions and reusable workflows for a repository @@ -42902,6 +44101,237 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": + get: + summary: List dependencies an issue is blocked by + description: |- + You can use the REST API to list the dependencies an issue is blocked by. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + post: + summary: Add a dependency an issue is blocked by + description: |- + You can use the REST API to add a 'blocked by' relationship to an issue. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': + "$ref": "#/components/responses/moved_permanently" + '403': + "$ref": "#/components/responses/forbidden" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": + delete: + summary: Remove dependency an issue is blocked by + description: |- + You can use the REST API to remove a dependency that an issue is blocked by. + + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + '301': + "$ref": "#/components/responses/moved_permanently" + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": + get: + summary: List dependencies an issue is blocking + description: |- + You can use the REST API to list the dependencies an issue is blocking. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events @@ -82342,6 +83772,84 @@ components: "$ref": "#/components/schemas/selected-actions-url" required: - enabled_organizations + 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. organization-simple: title: Organization Simple description: A GitHub organization. @@ -86836,6 +88344,89 @@ components: type: boolean description: A boolean value representing whether or not the token in the alert was detected in more than one location. + secret-scanning-row-version: + type: string + description: The version of the entity. This is used to confirm you're updating + the current version of the entity and mitigate unintentionally overriding + someone else's update. + nullable: true + secret-scanning-pattern-override: + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: string + description: The version of this pattern if it's a custom pattern. + nullable: true + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this pattern. + alert_total_percentage: + type: integer + description: The percentage of all alerts that this pattern represents, + rounded to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated by this pattern. + false_positive_rate: + type: integer + description: The percentage of alerts from this pattern that are false positives, + rounded to the nearest integer. + bypass_rate: + type: integer + description: The percentage of blocks for this pattern that were bypassed, + rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: string + description: The push protection setting for this pattern set at the enterprise + level. Only present for partner patterns when the organization has a parent + enterprise. + enum: + - not-set + - disabled + - enabled + nullable: true + setting: + type: string + description: The current push protection setting for this pattern. If this + is `not-set`, then it inherits either the enterprise setting if it exists + or the default setting. + enum: + - not-set + - disabled + - enabled + secret-scanning-pattern-configuration: + title: Secret scanning pattern configuration + description: A collection of secret scanning patterns and their settings related + to push protection. + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: + "$ref": "#/components/schemas/secret-scanning-pattern-override" + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: + "$ref": "#/components/schemas/secret-scanning-pattern-override" actions-billing-usage: type: object properties: @@ -87451,6 +89042,23 @@ components: - total - completed - percent_completed + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and @@ -87621,6 +89229,8 @@ components: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" required: - assignee - closed_at @@ -89391,6 +91001,23 @@ 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 nullable-simple-repository: title: Simple Repository description: A GitHub repository. @@ -102441,6 +104068,8 @@ components: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" required: - assignee - closed_at @@ -107137,6 +108766,8 @@ components: nullable: true sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: type: string state_reason: @@ -112152,6 +113783,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -113191,6 +114824,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -115095,6 +116730,55 @@ components: - name - created_at - updated_at + nullable-projects-v2-status-update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + start_date: + type: string + format: date + example: '2022-04-28' + target_date: + type: string + format: date + example: '2022-04-28' + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: + - id + - node_id + - created_at + - updated_at + nullable: true projects-v2: title: Projects v2 Project description: A projects v2 project @@ -115140,6 +116824,16 @@ components: nullable: true deleted_by: "$ref": "#/components/schemas/nullable-simple-user" + state: + type: string + enum: + - open + - closed + latest_status_update: + "$ref": "#/components/schemas/nullable-projects-v2-status-update" + is_template: + type: boolean + description: Whether this project is a template required: - id - node_id @@ -131265,6 +132959,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -132431,6 +134127,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -133604,6 +135302,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -134954,6 +136654,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -136014,6 +137716,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -136960,6 +138664,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -137889,6 +139595,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -138820,6 +140528,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -139774,6 +141484,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -140697,6 +142409,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -141602,6 +143316,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -142957,6 +144673,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -143931,6 +145649,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -144833,6 +146553,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -146340,6 +148062,8 @@ components: format: uri sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -217104,6 +218828,15 @@ components: enabled_organizations: all allowed_actions: selected selected_actions_url: https://api.github.com/enterprises/2/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 organization-targets: value: total_count: 1 @@ -218897,6 +220630,33 @@ components: first_location_detected: issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 has_more_locations: false + secret-scanning-pattern-configuration: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled actions-billing-usage: value: total_minutes_used: 305 @@ -220328,86 +222088,207 @@ components: 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} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - subject: - title: Greetings - url: https://api.github.com/repos/octokit/octokit.rb/issues/123 - latest_comment_url: https://api.github.com/repos/octokit/octokit.rb/issues/comments/123 - type: Issue - reason: subscribed - unread: true - updated_at: '2014-11-07T22:01:45Z' - last_read_at: '2014-11-07T22:01:45Z' - url: https://api.github.com/notifications/threads/1 - subscription_url: https://api.github.com/notifications/threads/1/subscription - thread-subscription: - value: - subscribed: true - ignored: false - reason: - created_at: '2012-10-06T21:34:12Z' - url: https://api.github.com/notifications/threads/1/subscription - thread_url: https://api.github.com/notifications/threads/1 - octocat: - value: |2 - MMM. .MMM - MMMMMMMMMMMMMMMMMMM - MMMMMMMMMMMMMMMMMMM ___________________________________ - MMMMMMMMMMMMMMMMMMMMM | | - MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. | - MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________| - MMMM::- -:::::::- -::MMMM |/ - MM~:~ 00~:::::~ 00~:~MM - .. MMMMM::.00:::+:::.00::MMMMM .. - .MM::::: ._. :::::MM. - MMMM;:::::;MMMM - -MM MMMMMMM - ^ M+ MMMMMMMMM - MMMMMMM MM MM MM - MM MM MM MM - MM MM MM MM - .~~MM~MM~MM~MM~~. - ~~~~MM:~MM~~~MM~:MM~~~~ - ~~~~~~==~==~~~==~==~~~~~~ - ~~~~~~==~==~==~==~~~~~~ - :~==~==~==~==~~ - organization-simple-items: - 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 - organization-custom-repository-role-example: - value: - id: 8030 - name: Security Engineer - description: Able to contribute code and maintain the security pipeline - base_role: maintain - permissions: - - delete_alerts_code_scanning - organization: - 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 - created_at: '2022-07-04T22:19:11Z' - updated_at: '2022-07-04T22:20:11Z' + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + subject: + title: Greetings + url: https://api.github.com/repos/octokit/octokit.rb/issues/123 + latest_comment_url: https://api.github.com/repos/octokit/octokit.rb/issues/comments/123 + type: Issue + reason: subscribed + unread: true + updated_at: '2014-11-07T22:01:45Z' + last_read_at: '2014-11-07T22:01:45Z' + url: https://api.github.com/notifications/threads/1 + subscription_url: https://api.github.com/notifications/threads/1/subscription + thread-subscription: + value: + subscribed: true + ignored: false + reason: + created_at: '2012-10-06T21:34:12Z' + url: https://api.github.com/notifications/threads/1/subscription + thread_url: https://api.github.com/notifications/threads/1 + octocat: + value: |2 + MMM. .MMM + MMMMMMMMMMMMMMMMMMM + MMMMMMMMMMMMMMMMMMM ___________________________________ + MMMMMMMMMMMMMMMMMMMMM | | + MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. | + MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________| + MMMM::- -:::::::- -::MMMM |/ + MM~:~ 00~:::::~ 00~:~MM + .. MMMMM::.00:::+:::.00::MMMMM .. + .MM::::: ._. :::::MM. + MMMM;:::::;MMMM + -MM MMMMMMM + ^ M+ MMMMMMMMM + MMMMMMM MM MM MM + MM MM MM MM + MM MM MM MM + .~~MM~MM~MM~MM~~. + ~~~~MM:~MM~~~MM~:MM~~~~ + ~~~~~~==~==~~~==~==~~~~~~ + ~~~~~~==~==~==~==~~~~~~ + :~==~==~==~==~~ + organization-simple-items: + 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 + organization-custom-repository-role-example: + value: + id: 8030 + name: Security Engineer + description: Able to contribute code and maintain the security pipeline + base_role: maintain + permissions: + - delete_alerts_code_scanning + organization: + 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 + 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 @@ -220575,127 +222456,6 @@ 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-2{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}